diff options
| author | Georg Brandl <georg@python.org> | 2009-01-22 19:25:24 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2009-01-22 19:25:24 +0100 |
| commit | bb71945aa4e0ab85be000858a05616f72a4ed2a3 (patch) | |
| tree | cd434864efc9e1e1d0f48baafd6bcfe8b402e2d7 /doc | |
| parent | 80e1fca6d542bef8bc213cda5516322b15054aa9 (diff) | |
| parent | 388277ae83ef94de163905144138d9ca6fe0dc7c (diff) | |
| download | sphinx-bb71945aa4e0ab85be000858a05616f72a4ed2a3.tar.gz | |
merge with trunk
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ext/autodoc.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 11ea4ab4..ccaf7ca8 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -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 |
