saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add info about how to build the docs with sphinx

Browse source
This commit is contained in:
Avi Marcus 2012-07-04 01:40:10 +03:00
parent b51123b9a8
commit a21aa82b65
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
HACKING.rst
View file

@ -32,6 +32,15 @@ those who are looking forward to contribute.
.. __: http://opencomparison.readthedocs.org/en/latest/contributing.html
Editing and Previewing the Docs
-------------------------------
You need ``sphinx-build`` to build the docs. In Debian/ubuntu, this is provided in the ``python-sphinx`` package.
Then::
cd doc; make html
Getting the tests running
-------------------------