A bit of clarification about where Sphinx finds autodoced modules.

1 files changed, 7 insertions, 0 deletions

diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst
index 993f971a..3e5ce3e1 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