IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

merge with trunk

Browse Source
This commit is contained in:
Georg Brandl
2009-01-22 19:25:24 +01:00
parent e285830b11 29cc19a199
commit 55c4f5a096
20 changed files with 37 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/ext/autodoc.rst
View File

@@ -12,6 +12,13 @@
This extension can import the modules you are documenting, and pull in
documentation from docstrings in a semi-automatic way.
.. note::
For Sphinx (actually, the Python interpreter that executes Sphinx) to find
your module, it must be importable. That means that the module or the
package must be in one of the directories on :data:`sys.path` -- adapt your
:data:`sys.path` in the configuration file accordingly.
For this to work, the docstrings must of course be written in correct
reStructuredText. You can then use all of the usual Sphinx markup in the
docstrings, and it will end up correctly in the documentation. Together with