deluge/docs/source/contributing/documentation.md

# Documentation contributions

## Build

We use Sphinx to create the documentation from source files and docstrings in code.

    pip install -r docs/requirements.txt
    python setup.py build_docs

The resulting html files are in `docs/build/html`.

## man pages

Located in `docs/man`
[Docs] Reorganise and add sections from wiki - Change the layout and contents of docs to be better organised and follow ideas from: https://www.divio.com/blog/documentation/ - Use markdown for non-technical documents to speed up writing. - Added new sections and imported documents from Trac wiki. Build fixes: - Added a patch to fix recommonmark 0.4 and doc referencing: https://github.com/rtfd/recommonmark/issues/93 - Set docs build in tox to Py2.7 since there are problems with autodoc mocking multiple inheritance on Python 3 resulting in metaclass errors. - Supressed warning about `modules.rst` not in the toctree by creating a static `modules.rst` with `:orphan:` file directive and add to git. Also skip creating this toc file with sphinx-apidoc in setup and tox. - Simplified finding exported RPC and JSON API methods by adding an autodoc custom class directive. Removed unneeded __rpcapi.py. 2018-10-05 08:33:26 +00:00			`# Documentation contributions`

			`## Build`

			`We use Sphinx to create the documentation from source files and docstrings in code.`

[Docs] Updates and fixes to build on Python 3 - Updates to the sphinx conf - Applied Mock fixes to build on Python 3. - Group patches at bottom of conf file. - Use just a major.minor for version. - Specify Sphinx 2.0 version requirement. - Move requirements.txt to docs dir. - Add readthedocs config - Fix docstring code block rst formatting issue. 2019-05-21 01:19:57 +00:00			`pip install -r docs/requirements.txt`
[Docs] Reorganise and add sections from wiki - Change the layout and contents of docs to be better organised and follow ideas from: https://www.divio.com/blog/documentation/ - Use markdown for non-technical documents to speed up writing. - Added new sections and imported documents from Trac wiki. Build fixes: - Added a patch to fix recommonmark 0.4 and doc referencing: https://github.com/rtfd/recommonmark/issues/93 - Set docs build in tox to Py2.7 since there are problems with autodoc mocking multiple inheritance on Python 3 resulting in metaclass errors. - Supressed warning about `modules.rst` not in the toctree by creating a static `modules.rst` with `:orphan:` file directive and add to git. Also skip creating this toc file with sphinx-apidoc in setup and tox. - Simplified finding exported RPC and JSON API methods by adding an autodoc custom class directive. Removed unneeded __rpcapi.py. 2018-10-05 08:33:26 +00:00			`python setup.py build_docs`

			The resulting html files are in `docs/build/html`.

			`## man pages`

			Located in `docs/man`