diff --git a/doc/api-quick-start/source/conf.py b/doc/api-quick-start/source/conf.py index 7adb65a3b2..c43d4a1b0e 100644 --- a/doc/api-quick-start/source/conf.py +++ b/doc/api-quick-start/source/conf.py @@ -50,19 +50,16 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -repository_name = 'openstack/api-site' -project = u'Openstack-API-Documentation' -bug_project = 'openstack-manuals' -bug_tag = u'api-site' -copyright = u'2017, OpenStack contributors' +openstackdocs_repo_name = 'openstack/openstack-manuals' +project = u'OpenStack API Documentation' +openstackdocs_bug_project = 'openstack-manuals' +openstackdocs_bug_tag = u'api-quick-start' +copyright = u'2017-2020, OpenStack contributors' +openstackdocs_auto_name = False -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. +# Do not show any version +openstackdocs_auto_version = False version = '' -# The full version, including alpha/beta/rc tags. release = '' # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/doc/common/source/conf.py b/doc/common/source/conf.py index 1b20e8b404..b95a29194e 100644 --- a/doc/common/source/conf.py +++ b/doc/common/source/conf.py @@ -52,20 +52,17 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -repository_name = "openstack/openstack-manuals" -bug_project = 'openstack-manuals' +openstackdocs_repo_name = "openstack/openstack-manuals" +openstackdocs_bug_project = 'openstack-manuals' project = u'Common documents' -bug_tag = u'common' +openstackdocs_bug_tag = u'common' +openstackdocs_auto_name = False -copyright = u'2015-2018, OpenStack contributors' +copyright = u'2015-2020, OpenStack contributors' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. +# Do not show any version +openstackdocs_auto_version = False version = '' -# The full version, including alpha/beta/rc tags. release = '' # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/doc/doc-contrib-guide/source/conf.py b/doc/doc-contrib-guide/source/conf.py index 733b506433..6db5d39d67 100644 --- a/doc/doc-contrib-guide/source/conf.py +++ b/doc/doc-contrib-guide/source/conf.py @@ -53,21 +53,17 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -repository_name = "openstack/openstack-manuals" -bug_project = 'openstack-manuals' +openstackdocs_repo_name = "openstack/openstack-manuals" +openstackdocs_bug_project = 'openstack-manuals' project = u'Documentation Contributor Guide' -bug_tag = u'doc-contrib-guide' +openstackdocs_bug_tag = u'doc-contrib-guide' +openstackdocs_auto_name = False -copyright = u'2015-2018, OpenStack contributors' +copyright = u'2015-2020, OpenStack contributors' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. +# Do not show any version +openstackdocs_auto_version = False version = '' -# The full version, including alpha/beta/rc tags. release = '' # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/doc/glossary/source/conf.py b/doc/glossary/source/conf.py index eae356fde0..5fd9f0ba5f 100644 --- a/doc/glossary/source/conf.py +++ b/doc/glossary/source/conf.py @@ -53,20 +53,16 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -repository_name = 'openstack/openstack-manuals' +openstackdocs_repo_name = 'openstack/openstack-manuals' project = u'Glossary' -bug_tag = u'glossary' +openstackdocs_bug_tag = u'glossary' +openstackdocs_auto_name = False -copyright = u'2015-2018, OpenStack contributors' +copyright = u'2015-2020, OpenStack contributors' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. +# Do not show any version +openstackdocs_auto_version = False version = '' -# The full version, including alpha/beta/rc tags. release = '' # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/doc/image-guide/source/conf.py b/doc/image-guide/source/conf.py index d6e2e24a55..721152260c 100644 --- a/doc/image-guide/source/conf.py +++ b/doc/image-guide/source/conf.py @@ -51,19 +51,18 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -repository_name = "openstack/openstack-manuals" -bug_project = 'openstack-manuals' +openstackdocs_repo_name = "openstack/openstack-manuals" +openstackdocs_bug_project = 'openstack-manuals' project = u'Virtual Machine Image Guide' -bug_tag = u'image-guide' -copyright = u'2015-2018, OpenStack contributors' +openstackdocs_auto_name = False +openstackdocs_bug_tag = u'image-guide' +copyright = u'2015-2020, OpenStack contributors' +openstackdocs_pdf_link = True +openstackdocs_pdf_filename = "ImageGuide.pdf" -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. +# Do not show any version +openstackdocs_auto_version = False version = '' -# The full version, including alpha/beta/rc tags. release = '' # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/doc/install-guide/source/conf.py b/doc/install-guide/source/conf.py index bb9f81cfe6..7bcd325f2d 100644 --- a/doc/install-guide/source/conf.py +++ b/doc/install-guide/source/conf.py @@ -51,19 +51,18 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -repository_name = "openstack/openstack-manuals" -bug_project = 'openstack-manuals' +openstackdocs_repo_name = "openstack/openstack-manuals" +openstackdocs_bug_project = 'openstack-manuals' project = u'Installation Guide' -bug_tag = u'install-guide' -copyright = u'2015-2018, OpenStack contributors' +openstackdocs_auto_name = False +openstackdocs_bug_tag = u'install-guide' +copyright = u'2015-2020, OpenStack contributors' +openstackdocs_pdf_link = True +openstackdocs_pdf_filename = "InstallGuide.pdf" -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. +# Do not show any version +openstackdocs_auto_version = False version = '' -# The full version, including alpha/beta/rc tags. release = '' # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 71cb0983e5..865fd1fe10 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -54,17 +54,11 @@ master_doc = 'index' # General information about the project. project = u'OpenStack Documentation Team Release Notes' -repository_name = "openstack/openstack-manuals" -bug_project = 'openstack-manuals' -bug_tag = u'releasenotes' -copyright = u'2017-2018, OpenStack contributors' - -# Release notes are version independent. -# The short X.Y version. -version = '' -# The full version, including alpha/beta/rc tags. -release = '' - +openstackdocs_repo_name = "openstack/openstack-manuals" +openstackdocs_bug_project = 'openstack-manuals' +openstackdocs_bug_tag = u'releasenotes' +copyright = u'2017-2020, OpenStack contributors' +openstackdocs_auto_name = False # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/test-requirements.txt b/test-requirements.txt index fca0ae0ac3..001c419334 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,8 +9,8 @@ hacking>=3.0,<3.1.0 # Apache-2.0 beautifulsoup4 # MIT Jinja2>=2.8 # BSD License (3 clause) openstack-doc-tools>=2.0.0 # Apache-2.0 -sphinx>=1.6.2 # BSD -openstackdocstheme>=1.23.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.0 # Apache-2.0 doc8 # Apache-2.0 requests>=2.14.2 # Apache-2.0 requestsexceptions>=1.2.0 # Apache-2.0