diff --git a/README.rst b/README.rst index 11621b61..e0c0b6f5 100644 --- a/README.rst +++ b/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 diff --git a/doc/requirements.txt b/doc/requirements.txt index e6783eef..efdb4e0b 100644 --- a/doc/requirements.txt +++ b/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 diff --git a/doc/source/conf.py b/doc/source/conf.py index 55e4bc84..ebec84c1 100755 --- a/doc/source/conf.py +++ b/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} diff --git a/doc/source/install/installation.rst b/doc/source/install/installation.rst index 9d758c7f..878e14eb 100644 --- a/doc/source/install/installation.rst +++ b/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`:: diff --git a/doc/source/overview.rst b/doc/source/overview.rst index b633180c..b5e2cbf2 100644 --- a/doc/source/overview.rst +++ b/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 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3582cbb5..0643338d 100644 --- a/releasenotes/source/conf.py +++ b/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'), ] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index e8c0d492..7e3d89b9 100644 --- a/releasenotes/source/index.rst +++ b/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 diff --git a/releasenotes/source/v1.0.0.rst b/releasenotes/source/v1.0.0.rst new file mode 100644 index 00000000..3a6e8b70 --- /dev/null +++ b/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 diff --git a/releasenotes/source/v1.1.0.rst b/releasenotes/source/v1.1.0.rst new file mode 100644 index 00000000..66d20db5 --- /dev/null +++ b/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 diff --git a/releasenotes/source/v1.1.2.rst b/releasenotes/source/v1.1.2.rst new file mode 100644 index 00000000..9607d6bf --- /dev/null +++ b/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 diff --git a/releasenotes/source/v1.1.4.rst b/releasenotes/source/v1.1.4.rst new file mode 100644 index 00000000..532a3f3f --- /dev/null +++ b/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 diff --git a/releasenotes/source/v2.0.0.rst b/releasenotes/source/v2.0.0.rst new file mode 100644 index 00000000..ab55df5d --- /dev/null +++ b/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 diff --git a/releasenotes/source/v2.1.0.rst b/releasenotes/source/v2.1.0.rst new file mode 100644 index 00000000..279a1e65 --- /dev/null +++ b/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 diff --git a/releasenotes/source/v2.2.0.rst b/releasenotes/source/v2.2.0.rst new file mode 100644 index 00000000..d980dec8 --- /dev/null +++ b/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 diff --git a/releasenotes/source/v2.2.1.rst b/releasenotes/source/v2.2.1.rst new file mode 100644 index 00000000..09e14c49 --- /dev/null +++ b/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 diff --git a/releasenotes/source/v2.3.0.rst b/releasenotes/source/v2.3.0.rst new file mode 100644 index 00000000..05ae6ba8 --- /dev/null +++ b/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 diff --git a/releasenotes/source/v2.4.0.rst b/releasenotes/source/v2.4.0.rst new file mode 100644 index 00000000..7a06f252 --- /dev/null +++ b/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 diff --git a/releasenotes/source/v2.5.0.rst b/releasenotes/source/v2.5.0.rst new file mode 100644 index 00000000..d1bdf652 --- /dev/null +++ b/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 diff --git a/releasenotes/source/v3.0.0.rst b/releasenotes/source/v3.0.0.rst new file mode 100644 index 00000000..f91a1e2f --- /dev/null +++ b/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 diff --git a/tox.ini b/tox.ini index 19d3ebe7..f153f9f9 100644 --- a/tox.ini +++ b/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 =