tools/docs/index.rst@97036ab72558
tools/docs/index.rst
Tue, 06 Jan 2015 21:39:09 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Tue, 06 Jan 2015 21:39:09 +0100
- branch
- TOR_BUG_9701
- changeset 8
- 97036ab72558
- permissions
- -rw-r--r--
Conditionally force memory storage according to privacy.thirdparty.isolate;
This solves Tor bug #9701, complying with disk avoidance documented in
https://www.torproject.org/projects/torbrowser/design/#disk-avoidance.
1 =================================
2 Mozilla Source Tree Documentation
3 =================================
5 .. toctree::
6 :maxdepth: 1
8 {indexes}
10 Python Packages
11 ===============
13 .. toctree::
14 :maxdepth: 2
16 {python_packages}
18 Managing Documentation
19 ======================
21 This documentation is generated via the
22 `Sphinx <http://sphinx-doc.org/>`_ tool from sources in the tree.
24 To build the documentation, run ``mach build-docs``. Run
25 ``mach help build-docs`` to see configurable options.
27 Adding Documentation
28 --------------------
30 To add new documentation, define the ``SPHINX_TREES`` and
31 ``SPHINX_PYTHON_PACKAGE_DIRS`` variables in ``moz.build`` files in
32 the tree and documentation will automatically get picked up.
34 Say you have a directory ``featureX`` you would like to write some
35 documentation for. Here are the steps to create Sphinx documentation
36 for it:
38 1. Create a directory for the docs. This is typically ``docs``. e.g.
39 ``featureX/docs``.
40 2. Create an ``index.rst`` file in this directory. The ``index.rst`` file
41 is the root documentation for that section. See ``build/docs/index.rst``
42 for an example file.
43 3. In a ``moz.build`` file (typically the one in the parent directory of
44 the ``docs`` directory), define ``SPHINX_TREES`` to hook up the plumbing.
45 e.g. ``SPHINX_TREES['featureX'] = 'docs'``. This says *the ``docs``
46 directory under the current directory should be installed into the
47 Sphinx documentation tree under ``/featureX``*.
48 4. If you have Python packages you would like to generate Python API
49 documentation for, you can use ``SPHINX_PYTHON_PACKAGE_DIRS`` to
50 declare directories containing Python packages. e.g.
51 ``SPHINX_PYTHON_PACKAGE_DIRS += ['mozpackage']``.
53 Indices and tables
54 ==================
56 * :ref:`genindex`
57 * :ref:`modindex`
58 * :ref:`search`
