PDF documentation build
Also reorganizes the document structure to match both HTML and PDF docs. Story: 2006100 Task: 35143 Change-Id: Ie3f38e2ecf52e6a6cbd52bb36196e6f589f1ca0f
This commit is contained in:
parent
3f286e7d8c
commit
6c0e4d7a39
|
@ -72,6 +72,20 @@ html_theme = 'openstackdocs'
|
||||||
# robots.txt.
|
# robots.txt.
|
||||||
html_extra_path = ['_extra']
|
html_extra_path = ['_extra']
|
||||||
|
|
||||||
|
# -- Options for LaTeX output -------------------------------------------------
|
||||||
|
|
||||||
|
latex_documents = [
|
||||||
|
('index', 'doc-python-novaclient.tex', u'python-novaclient Documentation',
|
||||||
|
u'OpenStack Foundation', 'manual'),
|
||||||
|
]
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
'extraclassoptions': 'openany,oneside',
|
||||||
|
'preamble': r'\setcounter{tocdepth}{4}',
|
||||||
|
'makeindex': '',
|
||||||
|
'printindex': '',
|
||||||
|
}
|
||||||
|
|
||||||
# -- Options for openstackdocstheme -------------------------------------------
|
# -- Options for openstackdocstheme -------------------------------------------
|
||||||
|
|
||||||
repository_name = 'openstack/python-novaclient'
|
repository_name = 'openstack/python-novaclient'
|
||||||
|
|
|
@ -15,3 +15,4 @@ __ https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
|
||||||
microversions
|
microversions
|
||||||
testing
|
testing
|
||||||
|
deprecation-policy
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
This is a client for OpenStack Nova API. There's a :doc:`Python API
|
This is a client for OpenStack Nova API. There's a :doc:`Python API
|
||||||
<reference/api/index>` (the :mod:`novaclient` module), and a :doc:`command-line
|
<reference/index>` (the :mod:`novaclient` module), and a :doc:`command-line
|
||||||
script </user/shell>` (installed as :program:`nova`). Each implements the
|
script </user/shell>` (installed as :program:`nova`). Each implements the
|
||||||
entire OpenStack Nova API.
|
entire OpenStack Nova API.
|
||||||
|
|
||||||
|
@ -22,6 +22,6 @@ such as TryStack, HP, or Rackspace, in order to use the nova client.
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
user/index
|
user/index
|
||||||
reference/index
|
|
||||||
cli/index
|
cli/index
|
||||||
|
reference/index
|
||||||
contributor/index
|
contributor/index
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
|
=========
|
||||||
Reference
|
Reference
|
||||||
=========
|
=========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 6
|
||||||
|
|
||||||
api/index
|
api/modules
|
||||||
deprecation-policy
|
|
||||||
|
|
|
@ -6,3 +6,4 @@
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
shell
|
shell
|
||||||
|
python-api
|
||||||
|
|
|
@ -101,9 +101,4 @@ Then call methods on its managers::
|
||||||
Reference
|
Reference
|
||||||
---------
|
---------
|
||||||
|
|
||||||
For more information, see the reference:
|
See :doc:`the module reference </reference/index>`.
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 6
|
|
||||||
|
|
||||||
modules
|
|
|
@ -87,12 +87,4 @@ From there, all shell commands take the form::
|
||||||
Run :program:`nova help` to get a full list of all possible commands, and run
|
Run :program:`nova help` to get a full list of all possible commands, and run
|
||||||
:program:`nova help <command>` to get detailed help for that command.
|
:program:`nova help <command>` to get detailed help for that command.
|
||||||
|
|
||||||
Reference
|
For more information, see :doc:`the command reference </cli/nova>`.
|
||||||
---------
|
|
||||||
|
|
||||||
For more information, see the reference:
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
/cli/nova
|
|
||||||
|
|
12
tox.ini
12
tox.ini
|
@ -9,6 +9,7 @@ usedevelop = True
|
||||||
whitelist_externals =
|
whitelist_externals =
|
||||||
find
|
find
|
||||||
rm
|
rm
|
||||||
|
make
|
||||||
passenv = ZUUL_CACHE_DIR
|
passenv = ZUUL_CACHE_DIR
|
||||||
REQUIREMENTS_PIP_LOCATION
|
REQUIREMENTS_PIP_LOCATION
|
||||||
install_command = pip install {opts} {packages}
|
install_command = pip install {opts} {packages}
|
||||||
|
@ -44,11 +45,20 @@ deps =
|
||||||
-r{toxinidir}/requirements.txt
|
-r{toxinidir}/requirements.txt
|
||||||
-r{toxinidir}/doc/requirements.txt
|
-r{toxinidir}/doc/requirements.txt
|
||||||
commands =
|
commands =
|
||||||
rm -rf doc/build
|
rm -rf doc/build/html doc/build/doctrees
|
||||||
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
||||||
# Test the redirects. This must run after the main docs build
|
# Test the redirects. This must run after the main docs build
|
||||||
whereto doc/build/html/.htaccess doc/test/redirect-tests.txt
|
whereto doc/build/html/.htaccess doc/test/redirect-tests.txt
|
||||||
|
|
||||||
|
[testenv:pdf-docs]
|
||||||
|
basepython = python3
|
||||||
|
envdir = {toxworkdir}/docs
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
|
commands =
|
||||||
|
rm -rf doc/build/pdf
|
||||||
|
sphinx-build -W -b latex doc/source doc/build/pdf
|
||||||
|
make -C doc/build/pdf
|
||||||
|
|
||||||
[testenv:releasenotes]
|
[testenv:releasenotes]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
deps =
|
deps =
|
||||||
|
|
Loading…
Reference in New Issue