Third-party extensions¶
You can find several extensions contributed by users in the Sphinx Contrib repository. It is open for anyone who wants to maintain an extension publicly; just send a short message asking for write permissions.
There are also several extensions hosted elsewhere. The Sphinx extension survey contains a comprehensive list.
If you write an extension that you think others will find useful or you think should be included as a part of Sphinx, please write to the project mailing list (join here).
Where to put your own extensions?¶
Extensions local to a project should be put within the project’s directory structure. Set Python’s module search path, sys.path
, accordingly so that Sphinx can find them. E.g., if your extension foo.py
lies in the exts
subdirectory of the project root, put into conf.py
:
import sys, os
sys.path.append(os.path.abspath('exts'))
extensions = ['foo']
You can also install extensions anywhere else on sys.path
, e.g. in the site-packages
directory.