diff --git a/doc/source/conf.py b/doc/source/conf.py index 37219009d..59af1189a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -78,11 +78,23 @@ htmlhelp_basename = '%sdoc' % project # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, - u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), + 'doc-%s.tex' % project, + u'Zun Documentation', + u'Zun development team', 'manual'), ] +# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664 +latex_use_xindy = False + +latex_domain_indices = False + +latex_elements = { + 'makeindex': '', + 'printindex': '', + 'preamble': r'\setcounter{tocdepth}{3}', + 'extraclassoptions': 'openany', +} + # Must set this variable to include year, month, day, hours, and minutes. html_last_updated_fmt = '%Y-%m-%d %H:%M' diff --git a/doc/source/configuration/sample-config.rst b/doc/source/configuration/sample-config.rst index 4db0f1039..614a59bff 100644 --- a/doc/source/configuration/sample-config.rst +++ b/doc/source/configuration/sample-config.rst @@ -7,7 +7,9 @@ auto-generated from Zun when this documentation is built, so if you are having issues with an option, please compare your version of Zun with the version of this documentation. -The sample configuration can also be viewed in :download:`file form -`. +.. only:: html -.. literalinclude:: /_static/zun.conf.sample + The sample configuration can also be viewed in :download:`file form + `. + + .. literalinclude:: /_static/zun.conf.sample diff --git a/doc/source/contributor/launchpad.rst b/doc/source/contributor/launchpad.rst index 1d5591f21..17ca039c0 100644 --- a/doc/source/contributor/launchpad.rst +++ b/doc/source/contributor/launchpad.rst @@ -27,11 +27,15 @@ Launchpad credentials Creating a login on Launchpad is important even if you don't use the Launchpad site itself, since Launchpad credentials are used for logging in on several -OpenStack-related sites. These sites include: +OpenStack-related sites. - * `Wiki`_ - * Gerrit (see :doc:`gerrit`) - * Jenkins (see :doc:`jenkins`) +.. only:: html + + These sites include: + + * `Wiki`_ + * Gerrit (see :doc:`gerrit`) + * Jenkins (see :doc:`jenkins`) Feature requests (Blueprints) ----------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 2ed1e7cb8..0e0265f48 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -78,26 +78,20 @@ Please ensure that you follow their install guides first. For Contributors ================ -If you are new to Zun, this should help you quickly setup the development -environment and get started. +If you are new to Zun, the developer quick-start guide should help you quickly +setup the development environment and get started. +There are also a number of technical references on various topics +collected in contributors guide. .. toctree:: :glob: :maxdepth: 2 contributor/quickstart - -There are also a number of technical references on various topics. -These are collected below. - -.. toctree:: - :glob: - :maxdepth: 2 - contributor/index -Reference Material -================== +Additional Material +=================== .. toctree:: :glob: @@ -107,11 +101,13 @@ Reference Material admin/index configuration/index user/filter-scheduler - reference/api-microversion-history + reference/index -Search -====== +.. only:: html -* :ref:`Zun document search `: Search the contents of this document. -* `OpenStack wide search `_: Search the wider - set of OpenStack documentation, including forums. + Search + ====== + + * :ref:`Zun document search `: Search the contents of this document. + * `OpenStack wide search `_: Search the wider + set of OpenStack documentation, including forums. diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 000000000..18514810d --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,8 @@ +Reference Material +================== + +.. toctree:: + :glob: + :maxdepth: 1 + + api-microversion-history diff --git a/tox.ini b/tox.ini index 15442844b..c381c1203 100644 --- a/tox.ini +++ b/tox.ini @@ -58,6 +58,16 @@ deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html +[testenv:pdf-docs] +basepython = python3 +envdir = {toxworkdir}/docs +deps = {[testenv:docs]deps} +whitelist_externals = + make +commands = + sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf + [testenv:debug] basepython = python3 commands = oslo_debug_helper {posargs}