Anonymous avatar Anonymous committed cabeb6a

Add a note about sys.path in conf.py.

Comments (0)

Files changed (1)

    extensions coming with Sphinx (named ``sphinx.addons.*``) or custom ones.
 
    Note that you can extend :data:`sys.path` within the conf file if your
-   extensions live in another directory.
+   extensions live in another directory -- but make sure you use absolute
+   paths.  If your extension path is relative to the documentation root, use
+   :func:`os.path.abspath` like so::
+
+      import sys, os
+
+      sys.path.append(os.path.abspath('sphinxext'))
+
+      extensions = ['extname']
+
+   That way, you can load an extension called ``extname`` from the documentation
+   root's subdirectory ``sphinxext``.
 
 .. confval:: templates_path
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.