openstack/openstack-manuals
Code Issues Proposed changes

[contributor] Add sphinxmark to Contributor Guide

Browse Source 
Add sphinxmark to packages that require manual installation
when not using tox.
Add note that the sphinxmark dep Pillow may require
installation of external C libraries on some systems.

Change-Id: I7a001eddeb83a30017fd292cb0cb313b89b2df07
This commit is contained in:
Brian Moss 2016-09-07 08:20:48 +10:00
parent d56622b194
commit f4fc823125
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/contributor-guide/source/docs-builds.rst
View File

@ -89,6 +89,17 @@ If you do not want to use Tox, install the below prerequisites locally:
# pip install sphinx
# pip install openstackdocstheme
# pip install sphinxmark
.. note::
Sphinxmark uses the `Pillow module
<http://pillow.readthedocs.io/en/3.1.x/index.html>`_ for creating PNG files.
If you encounter ``C module is not installed`` errors when Sphinx loads the
sphinxmark extension, you may need to install some of the
`external libraries
<http://pillow.readthedocs.io/en/3.1.x/installation.html#external-libraries>`_
for Pillow.
To get the ``.html`` output locally, switch to the directory containing a
``conf.py`` and run: