mirror of
https://github.com/spiral-project/ihatemoney.git
synced 2025-04-29 01:42:37 +02:00
Add doc building instructions (#263)
This commit is contained in:
parent
2ec4fb589f
commit
ee1ecbf3e7
1 changed files with 16 additions and 0 deletions
|
@ -99,6 +99,22 @@ update the issue tracker with your feedback.
|
||||||
|
|
||||||
Thanks again!
|
Thanks again!
|
||||||
|
|
||||||
|
How to build the documentation ?
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
The documentation is using `sphinx <http://www.sphinx-doc.org/en/stable/>`_ and
|
||||||
|
its source is located inside the `docs folder
|
||||||
|
<https://github.com/spiral-project/ihatemoney/tree/master/docs>`_.
|
||||||
|
|
||||||
|
Install doc dependencies (within the virtualenv, if any)::
|
||||||
|
|
||||||
|
pip install -r docs/requirements.txt
|
||||||
|
|
||||||
|
And to produce html doc in `docs/_output` folder::
|
||||||
|
|
||||||
|
cd docs/
|
||||||
|
make html
|
||||||
|
|
||||||
How to release?
|
How to release?
|
||||||
===============
|
===============
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue