`comments in Python source code` to `Python docstrings`
This commit is contained in:
parent
517cfad4df
commit
5ac52da14c
|
@ -29,6 +29,6 @@ If you have Sphinx and Make installed, you can also run `make html`
|
||||||
within the docs directory. You may also need to install some
|
within the docs directory. You may also need to install some
|
||||||
additional Python packages, such as `setuptools` and `recommonmark`.
|
additional Python packages, such as `setuptools` and `recommonmark`.
|
||||||
|
|
||||||
Note that Sphinx can also process comments in Python source code to
|
Note that Sphinx can also process Python docstrings to generate API
|
||||||
generate API documentation. Tahoe-LAFS currently does not use Sphinx
|
documentation. Tahoe-LAFS currently does not use Sphinx for this
|
||||||
for this purpose.
|
purpose.
|
||||||
|
|
Loading…
Reference in New Issue