alexcamposruiz
commented
3 years ago Should "Quick Reference" come after "Building and Installing" or even after "Introduction"? Seems odd as the very first topic, before "Introduction."
® should go with the first mention of Python (which I did, in the intro.rst). Did you run "Python API" by Legal? Somehow, "Python® API doesn't seem right (because it's our API, not Python's), so I avoided that. Python's trademark language seems to suggest we need permission to use Python in certain contexts ("Some uses, like calling a company "The Python Company," or a product "Python Language" or "Python IDE" will be refused"); see here: https://www.python.org/psf/trademarks/. Run by Legal if you haven't already.
How do you build the help? I just used sphinx-build on my local machine, but then that didn't pick up the API Reference doc. (Maybe I should use the official build machine?) Note that the URL you shared with me (http://devtools.rti.com/~alejandro/connextdds-py/rti.html#module-rti) didn't successfully pick up content for the Module Contents section.
Yes, we can move the quick reference down. You won't be able to build the reference API documentation. It requires building the code first.
Should "Quick Reference" come after "Building and Installing" or even after "Introduction"? Seems odd as the very first topic, before "Introduction."
® should go with the first mention of Python (which I did, in the intro.rst). Did you run "Python API" by Legal? Somehow, "Python® API doesn't seem right (because it's our API, not Python's), so I avoided that. Python's trademark language seems to suggest we need permission to use Python in certain contexts ("Some uses, like calling a company "The Python Company," or a product "Python Language" or "Python IDE" will be refused"); see here: https://www.python.org/psf/trademarks/. Run by Legal if you haven't already.
How do you build the help? I just used sphinx-build on my local machine, but then that didn't pick up the API Reference doc. (Maybe I should use the official build machine?) Note that the URL you shared with me (http://devtools.rti.com/~alejandro/connextdds-py/rti.html#module-rti) didn't successfully pick up content for the Module Contents section.