To add new documentation, define the
SPHINX_PYTHON_PACKAGE_DIRS variables in
moz.build files in
the tree and documentation will automatically get picked up.
Say you have a directory
featureX you would like to write some
documentation for. Here are the steps to create Sphinx documentation
- Create a directory for the docs. This is typically
- Create an
index.rstfile in this directory. The
index.rstfile is the root documentation for that section. See
build/docs/index.rstfor an example file.
- In a
moz.buildfile (typically the one in the parent directory of the
SPHINX_TREESto hook up the plumbing. e.g.
SPHINX_TREES['featureX'] = 'docs'. This says the ``docs`` directory under the current directory should be installed into the Sphinx documentation tree under ``/featureX``.
- If you have Python packages you would like to generate Python API
documentation for, you can use
SPHINX_PYTHON_PACKAGE_DIRSto declare directories containing Python packages. e.g.
SPHINX_PYTHON_PACKAGE_DIRS += ['mozpackage'].
tools/docs/config.yml, defines in which category the doc should go.
- Verify the rst syntax using ./mach lint -l rst