valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-06 08:35:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add more specifics about building docs: where they get built, what markup, and where the main info is stored

Browse Source
This commit is contained in:
Avi Marcus 2012-07-04 02:06:57 +03:00
parent e0d21d476b
commit cc029ccc34
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
HACKING.rst
View File

@ -42,6 +42,10 @@ Then::
cd doc; make html cd doc; make html
- The docs then are built in the ``docs/_build/html/`` folder. If you make changes and want to see the results, ``make html`` again.
- The docs use ``reStructuredText`` for markup. See a live demo at http://rst.ninjs.org/
- The help information on each module or state is culled from the python code that runs for that piece. Find them in ``salt/modules/`` or ``salt/states/``
Getting the tests running Getting the tests running
------------------------- -------------------------