mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
36 lines
1.3 KiB
ReStructuredText
36 lines
1.3 KiB
ReStructuredText
|
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 <http://sphinxext-survey.readthedocs.org/en/latest/>`__ 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 <https://groups.google.com/forum/#!forum/sphinx-dev>`_).
|
||
|
|
|
||
|
|
.. _Sphinx Contrib: https://bitbucket.org/birkenfeld/sphinx-contrib
|
||
|
|
|
||
|
|
|
||
|
|
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 :file:`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.
|