Sphinx-RTD-Tutorial icon indicating copy to clipboard operation
Sphinx-RTD-Tutorial copied to clipboard

A tutorial on how to use Sphinx

Results 10 Sphinx-RTD-Tutorial issues
Sort by recently updated
recently updated
newest added

little cosmetics, mainly fix .rts to .rts

I noticed a problem with the syntax of optional parameters (#9) and suggested to remove them from the tutorial. This PR does exactly that. Since the html build was changed...

... This makes it difficult for someone not on Linux (say on a Mac) to follow the tutorial.

Just enabling `sys.path.insert(0, os.path.abspath('../../simpleble/'))` isn't enough for the `autodoc` extension to work: the extension itself has to be enabled first.

In [your tutorial](https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html#the-sphinx-docstring-format), you suggest using `, optional` after the parameter type to denote that a parameter is optional. However, according to the following sources, this is not the official...

As far as I can see, the tutorial does not include instructions on how to enable the autodoc extension for Sphinx in the first place. The file `conf.py` has to...