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

Merge pull request #18148 from rallytime/six_docs_build

Browse Source 
[don't merge!!] Add six dependency notice to building docs intructions
This commit is contained in:
Seth House 2014-11-17 21:02:33 -06:00
commit 3858de8776
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/topics/development/conventions/documentation.rst
View File

@ -290,8 +290,15 @@ cross-referenced using two custom roles, ``conf_master`` and ``conf_minion``.
Building the documentation
==========================
1. Install Sphinx using a system package manager or pip. The package name is
often of the form ``python-sphinx``. There are no other dependencies.
1. Install Sphinx using a system package manager. The other dependency
needed to build the docs is ``six``. The package names are often of the
form ``python-sphinx`` and ``python-six``. Both packages can also be
installed in a virtualenv with pip:
.. code-block:: bash
pip install Sphinx
pip install six
2. Build the documentation using the provided Makefile or ``.bat`` file on
Windows.

6
doc/topics/development/hacking.rst
View File

@ -226,12 +226,14 @@ Editing and previewing the documentation
----------------------------------------
You need ``sphinx-build`` command to build the docs. In Debian/Ubuntu this is
provided in the ``python-sphinx`` package. Sphinx can also be installed
to a virtualenv using pip:
provided in the ``python-sphinx`` package. ``six`` is also needed to build the
docs and is available on Debian/Ubuntu systems as ``python-six``. Sphinx and
six can also be installed to a virtualenv using pip:
.. code-block:: bash
pip install Sphinx
pip install six
Change to salt documentation directory, then: