Merge "[install-guide] The guide is version independent"
This commit is contained in:
commit
622a4370b9
@ -147,17 +147,6 @@ If you do not want to use Tox, install the below prerequisites locally:
|
|||||||
|
|
||||||
# pip install sphinx
|
# pip install sphinx
|
||||||
# pip install openstackdocstheme
|
# 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
|
To get the ``.html`` output locally, switch to the directory containing a
|
||||||
``conf.py`` and run:
|
``conf.py`` and run:
|
||||||
|
@ -38,7 +38,7 @@ import openstackdocstheme
|
|||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = ['sphinxmark', 'openstackdocstheme']
|
extensions = ['openstackdocstheme']
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
# templates_path = ['_templates']
|
# templates_path = ['_templates']
|
||||||
@ -306,9 +306,3 @@ pdf_documents = [
|
|||||||
('index', u'InstallGuide', u'Install Guide',
|
('index', u'InstallGuide', u'Install Guide',
|
||||||
u'OpenStack contributors')
|
u'OpenStack contributors')
|
||||||
]
|
]
|
||||||
|
|
||||||
# -- Options for sphinxmark -----------------------------------------------
|
|
||||||
sphinxmark_enable = True
|
|
||||||
sphinxmark_div = 'docs-body'
|
|
||||||
sphinxmark_image = 'text'
|
|
||||||
sphinxmark_text = 'Pike'
|
|
||||||
|
@ -23,7 +23,7 @@ are included.
|
|||||||
Please see the
|
Please see the
|
||||||
`OpenStack Training Labs <https://docs.openstack.org/training_labs/>`_.
|
`OpenStack Training Labs <https://docs.openstack.org/training_labs/>`_.
|
||||||
|
|
||||||
This guide documents the OpenStack Ocata release.
|
This guide documents the OpenStack Pike release.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
|
@ -15,7 +15,6 @@ doc8 # Apache-2.0
|
|||||||
requests>=2.14.2 # Apache-2.0
|
requests>=2.14.2 # Apache-2.0
|
||||||
requestsexceptions>=1.2.0 # Apache-2.0
|
requestsexceptions>=1.2.0 # Apache-2.0
|
||||||
reno>=1.8.0,!=2.3.1 # Apache-2.0
|
reno>=1.8.0,!=2.3.1 # Apache-2.0
|
||||||
sphinxmark>=0.1.19 # Apache-2.0
|
|
||||||
lxml>=2.3,!=3.7.0 # BSD
|
lxml>=2.3,!=3.7.0 # BSD
|
||||||
PyYAML>=3.10.0 # MIT
|
PyYAML>=3.10.0 # MIT
|
||||||
jsonschema>=2.6.0
|
jsonschema>=2.6.0
|
||||||
@ -24,4 +23,3 @@ jsonschema>=2.6.0
|
|||||||
# Babel 2.4.0 is broken, fixed in 2.4.1
|
# Babel 2.4.0 is broken, fixed in 2.4.1
|
||||||
Babel>=2.3.4,!=2.4.0 # BSD
|
Babel>=2.3.4,!=2.4.0 # BSD
|
||||||
|
|
||||||
Pillow>=2.4.0 # PIL License
|
|
||||||
|
Loading…
Reference in New Issue
Block a user