Browse Source

Fix doc, releasenotes plus build pdf

This patch enables building .pdf documentation using new 'pdf-docs'
tox environment. The newly created tox environment creates latex
source codes using sphinx-build and then builds the pdf
documentation using make.
The patch also fixes documentation to reflect change from openstack
to osf organization fixes copy-paste mistakes in the doc configs.

Change-Id: I15a03442c2a2c355c8e7f1658c1b2329eb38c7df
changes/36/762736/6
Martin Kopec 11 months ago
parent
commit
e8fac460b8
  1. 2
      README.rst
  2. 1
      doc/requirements.txt
  3. 11
      doc/source/conf.py
  4. 2
      doc/source/install/installation.rst
  5. 2
      doc/source/overview.rst
  6. 23
      releasenotes/source/conf.py
  7. 12
      releasenotes/source/index.rst
  8. 6
      releasenotes/source/v1.0.0.rst
  9. 6
      releasenotes/source/v1.1.0.rst
  10. 6
      releasenotes/source/v1.1.2.rst
  11. 6
      releasenotes/source/v1.1.4.rst
  12. 6
      releasenotes/source/v2.0.0.rst
  13. 6
      releasenotes/source/v2.1.0.rst
  14. 6
      releasenotes/source/v2.2.0.rst
  15. 6
      releasenotes/source/v2.2.1.rst
  16. 6
      releasenotes/source/v2.3.0.rst
  17. 6
      releasenotes/source/v2.4.0.rst
  18. 6
      releasenotes/source/v2.5.0.rst
  19. 6
      releasenotes/source/v3.0.0.rst
  20. 8
      tox.ini

2
README.rst

@ -9,6 +9,6 @@ based on your cloud.
- Free software: Apache license
- Documentation: https://docs.openstack.org/python-tempestconf/latest/
- Source: https://opendev.org/openstack/python-tempestconf
- Source: https://opendev.org/osf/python-tempestconf
- Bugs: https://storyboard.openstack.org/#!/project/912
- Release notes: https://docs.openstack.org/releasenotes/python-tempestconf

1
doc/requirements.txt

@ -2,3 +2,4 @@ openstackdocstheme>=2.2.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
sphinx-argparse>=0.2.2 # MIT
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

11
doc/source/conf.py

@ -21,13 +21,15 @@ extensions = [
'openstackdocstheme',
#'sphinx.ext.intersphinx',
'sphinx.ext.autodoc',
'sphinxcontrib.rsvgconverter',
'sphinxarg.ext'
]
html_theme = 'openstackdocs'
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/python-tempestconf'
openstackdocs_repo_name = 'osf/python-tempestconf'
openstackdocs_pdf_link = True
openstackdocs_use_storyboard = True
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -70,10 +72,15 @@ htmlhelp_basename = '%sdoc' % project
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
'doc-%s.tex' % project,
u'%s Documentation' % project,
u'Red Hat, Inc.', 'manual'),
]
latex_use_xindy = False
latex_elements = {
'extraclassoptions': 'openany,oneside',
}
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}

2
doc/source/install/installation.rst

@ -7,7 +7,7 @@ Git
1. Clone and change to the directory::
$ git clone https://opendev.org/openstack/python-tempestconf
$ git clone https://opendev.org/osf/python-tempestconf
$ cd python-tempestconf
2. Create a virtual environment using :command:`virtualenv`::

2
doc/source/overview.rst

@ -8,7 +8,7 @@ based on your cloud.
- Free software: Apache license
- Documentation:
https://docs.openstack.org/python-tempestconf/latest/
- Source: https://opendev.org/openstack/python-tempestconf
- Source: https://opendev.org/osf/python-tempestconf
- Bugs: https://storyboard.openstack.org/#!/project/912
- Release notes: https://docs.openstack.org/releasenotes/python-tempestconf

23
releasenotes/source/conf.py

@ -43,7 +43,7 @@ extensions = [
]
# openstackdocstheme options
openstackdocs_repo_name = 'openstack/python-tempestconf'
openstackdocs_repo_name = 'osf/python-tempestconf'
openstackdocs_use_storyboard = True
# Add any paths that contain templates here, relative to this directory.
@ -59,7 +59,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
copyright = u'2016, OpenStack Foundation'
project = 'python-tempestconf'
copyright = u'2016, Red Hat'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -182,7 +183,7 @@ html_static_path = ['_static']
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'GlanceReleaseNotesdoc'
htmlhelp_basename = '%sReleaseNotesdoc' % project
# -- Options for LaTeX output ---------------------------------------------
@ -202,8 +203,8 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'GlanceReleaseNotes.tex', u'Glance Release Notes Documentation',
u'Glance Developers', 'manual'),
('index', '%s.tex' % project, u'%s Release Notes Documentation' % project,
u'Red Hat, Inc.', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@ -232,8 +233,9 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'glancereleasenotes', u'Glance Release Notes Documentation',
[u'Glance Developers'], 1)
('index', '%sReleasenotes' % project,
u'%s Release Notes Documentation' % project,
[u'Red Hat, Inc.'], 1)
]
# If true, show URL addresses after external links.
@ -246,9 +248,10 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'GlanceReleaseNotes', u'Glance Release Notes Documentation',
u'Glance Developers', 'GlanceReleaseNotes',
'One line description of project.',
('index', '%sReleaseNotes' % project,
u'%s Release Notes Documentation' % project,
u'Red Hat, Inc.', '%sReleaseNotes' % project,
'%s will automatically generate the tempest configuration.' % project,
'Miscellaneous'),
]

12
releasenotes/source/index.rst

@ -6,3 +6,15 @@
:maxdepth: 1
unreleased
v3.0.0
v2.5.0
v2.4.0
v2.3.0
v2.2.1
v2.2.0
v2.1.0
v2.0.0
v1.1.4
v1.1.2
v1.1.0
v1.0.0

6
releasenotes/source/v1.0.0.rst

@ -0,0 +1,6 @@
====================
v1.0.0 Release Notes
====================
.. release-notes:: 1.0.0 Release Notes
:version: 1.0.0

6
releasenotes/source/v1.1.0.rst

@ -0,0 +1,6 @@
====================
v1.1.0 Release Notes
====================
.. release-notes:: 1.1.0 Release Notes
:version: 1.1.0

6
releasenotes/source/v1.1.2.rst

@ -0,0 +1,6 @@
====================
v1.1.2 Release Notes
====================
.. release-notes:: 1.1.2 Release Notes
:version: 1.1.2

6
releasenotes/source/v1.1.4.rst

@ -0,0 +1,6 @@
====================
v1.1.4 Release Notes
====================
.. release-notes:: 1.1.4 Release Notes
:version: 1.1.4

6
releasenotes/source/v2.0.0.rst

@ -0,0 +1,6 @@
====================
v2.0.0 Release Notes
====================
.. release-notes:: 2.0.0 Release Notes
:version: 2.0.0

6
releasenotes/source/v2.1.0.rst

@ -0,0 +1,6 @@
====================
v2.1.0 Release Notes
====================
.. release-notes:: 2.1.0 Release Notes
:version: 2.1.0

6
releasenotes/source/v2.2.0.rst

@ -0,0 +1,6 @@
====================
v2.2.0 Release Notes
====================
.. release-notes:: 2.2.0 Release Notes
:version: 2.2.0

6
releasenotes/source/v2.2.1.rst

@ -0,0 +1,6 @@
====================
v2.2.1 Release Notes
====================
.. release-notes:: 2.2.1 Release Notes
:version: 2.2.1

6
releasenotes/source/v2.3.0.rst

@ -0,0 +1,6 @@
====================
v2.3.0 Release Notes
====================
.. release-notes:: 2.3.0 Release Notes
:version: 2.3.0

6
releasenotes/source/v2.4.0.rst

@ -0,0 +1,6 @@
====================
v2.4.0 Release Notes
====================
.. release-notes:: 2.4.0 Release Notes
:version: 2.4.0

6
releasenotes/source/v2.5.0.rst

@ -0,0 +1,6 @@
====================
v2.5.0 Release Notes
====================
.. release-notes:: 2.5.0 Release Notes
:version: 2.5.0

6
releasenotes/source/v3.0.0.rst

@ -0,0 +1,6 @@
====================
v3.0.0 Release Notes
====================
.. release-notes:: 3.0.0 Release Notes
:version: 3.0.0

8
tox.ini

@ -44,6 +44,14 @@ commands =
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -b html doc/source doc/build/html
[testenv:pdf-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:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt
commands =

Loading…
Cancel
Save