blob: fc03756fbe6d46e8297d82576579e233ef902150 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
Managing Documentation
======================
Documentation is hard. It's difficult to write, difficult to find and always out
of date. That's why we implemented our in-tree documentation system that
underpins firefox-source-docs.mozilla.org. The documentation lives next to the
code that it documents, so it can be updated within the same commit that makes
the underlying changes.
This documentation is generated via the
`Sphinx <http://sphinx-doc.org/>`_ tool from sources in the tree.
To build the documentation, run ``mach doc``. Run
``mach help doc`` to see configurable options.
The review group in Phabricator is ``#firefox-source-docs-reviewers``.
For simple documentation changes, reviews are not required.
.. toctree::
:caption: Documentation
:maxdepth: 2
:glob:
*
|
