codex-storage/deluge
1
0
Fork 0
mirror of https://github.com/codex-storage/deluge.git synced 2025-01-11 03:55:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
deluge/docs/source/contributing/documentation.md
Calum Lind 65f6ede8b2 [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 15:23:45 +01:00

287 B
Raw Blame History

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