Update openstackdocstheme version
Switch to openstackdocstheme 2.2.0 version. Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Set openstackdocs_auto_version to not version the documents and openstackdocs_auto_name to use project as name. Set openstackdocs_pdf_link to link to PDF files for the two guides that build PDFs. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Update copyright. Change-Id: Ibd4844364d78abd135e5b094beba8f17503fab26
This commit is contained in:
parent
0c714e5150
commit
075cf9aeba
@ -50,19 +50,16 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
repository_name = 'openstack/api-site'
|
openstackdocs_repo_name = 'openstack/openstack-manuals'
|
||||||
project = u'Openstack-API-Documentation'
|
project = u'OpenStack API Documentation'
|
||||||
bug_project = 'openstack-manuals'
|
openstackdocs_bug_project = 'openstack-manuals'
|
||||||
bug_tag = u'api-site'
|
openstackdocs_bug_tag = u'api-quick-start'
|
||||||
copyright = u'2017, OpenStack contributors'
|
copyright = u'2017-2020, OpenStack contributors'
|
||||||
|
openstackdocs_auto_name = False
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# Do not show any version
|
||||||
# |version| and |release|, also used in various other places throughout the
|
openstackdocs_auto_version = False
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# The short X.Y version.
|
|
||||||
version = ''
|
version = ''
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = ''
|
release = ''
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
@ -52,20 +52,17 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
repository_name = "openstack/openstack-manuals"
|
openstackdocs_repo_name = "openstack/openstack-manuals"
|
||||||
bug_project = 'openstack-manuals'
|
openstackdocs_bug_project = 'openstack-manuals'
|
||||||
project = u'Common documents'
|
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
|
# Do not show any version
|
||||||
# |version| and |release|, also used in various other places throughout the
|
openstackdocs_auto_version = False
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# The short X.Y version.
|
|
||||||
version = ''
|
version = ''
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = ''
|
release = ''
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
@ -53,21 +53,17 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
repository_name = "openstack/openstack-manuals"
|
openstackdocs_repo_name = "openstack/openstack-manuals"
|
||||||
bug_project = 'openstack-manuals'
|
openstackdocs_bug_project = 'openstack-manuals'
|
||||||
project = u'Documentation Contributor Guide'
|
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'
|
||||||
|
|
||||||
|
# Do not show any version
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
openstackdocs_auto_version = False
|
||||||
# |version| and |release|, also used in various other places throughout the
|
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# The short X.Y version.
|
|
||||||
version = ''
|
version = ''
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = ''
|
release = ''
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
@ -53,20 +53,16 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
repository_name = 'openstack/openstack-manuals'
|
openstackdocs_repo_name = 'openstack/openstack-manuals'
|
||||||
project = u'Glossary'
|
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'
|
||||||
|
|
||||||
|
# Do not show any version
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
openstackdocs_auto_version = False
|
||||||
# |version| and |release|, also used in various other places throughout the
|
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# The short X.Y version.
|
|
||||||
version = ''
|
version = ''
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = ''
|
release = ''
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
@ -51,19 +51,18 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
repository_name = "openstack/openstack-manuals"
|
openstackdocs_repo_name = "openstack/openstack-manuals"
|
||||||
bug_project = 'openstack-manuals'
|
openstackdocs_bug_project = 'openstack-manuals'
|
||||||
project = u'Virtual Machine Image Guide'
|
project = u'Virtual Machine Image Guide'
|
||||||
bug_tag = u'image-guide'
|
openstackdocs_auto_name = False
|
||||||
copyright = u'2015-2018, OpenStack contributors'
|
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
|
# Do not show any version
|
||||||
# |version| and |release|, also used in various other places throughout the
|
openstackdocs_auto_version = False
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# The short X.Y version.
|
|
||||||
version = ''
|
version = ''
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = ''
|
release = ''
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
@ -51,19 +51,18 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
repository_name = "openstack/openstack-manuals"
|
openstackdocs_repo_name = "openstack/openstack-manuals"
|
||||||
bug_project = 'openstack-manuals'
|
openstackdocs_bug_project = 'openstack-manuals'
|
||||||
project = u'Installation Guide'
|
project = u'Installation Guide'
|
||||||
bug_tag = u'install-guide'
|
openstackdocs_auto_name = False
|
||||||
copyright = u'2015-2018, OpenStack contributors'
|
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
|
# Do not show any version
|
||||||
# |version| and |release|, also used in various other places throughout the
|
openstackdocs_auto_version = False
|
||||||
# built documents.
|
|
||||||
#
|
|
||||||
# The short X.Y version.
|
|
||||||
version = ''
|
version = ''
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = ''
|
release = ''
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
@ -54,17 +54,11 @@ master_doc = 'index'
|
|||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'OpenStack Documentation Team Release Notes'
|
project = u'OpenStack Documentation Team Release Notes'
|
||||||
repository_name = "openstack/openstack-manuals"
|
openstackdocs_repo_name = "openstack/openstack-manuals"
|
||||||
bug_project = 'openstack-manuals'
|
openstackdocs_bug_project = 'openstack-manuals'
|
||||||
bug_tag = u'releasenotes'
|
openstackdocs_bug_tag = u'releasenotes'
|
||||||
copyright = u'2017-2018, OpenStack contributors'
|
copyright = u'2017-2020, OpenStack contributors'
|
||||||
|
openstackdocs_auto_name = False
|
||||||
# Release notes are version independent.
|
|
||||||
# The short X.Y version.
|
|
||||||
version = ''
|
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = ''
|
|
||||||
|
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
|
@ -9,8 +9,8 @@ hacking>=3.0,<3.1.0 # Apache-2.0
|
|||||||
beautifulsoup4 # MIT
|
beautifulsoup4 # MIT
|
||||||
Jinja2>=2.8 # BSD License (3 clause)
|
Jinja2>=2.8 # BSD License (3 clause)
|
||||||
openstack-doc-tools>=2.0.0 # Apache-2.0
|
openstack-doc-tools>=2.0.0 # Apache-2.0
|
||||||
sphinx>=1.6.2 # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
openstackdocstheme>=1.23.1 # Apache-2.0
|
openstackdocstheme>=2.2.0 # Apache-2.0
|
||||||
doc8 # Apache-2.0
|
doc8 # Apache-2.0
|
||||||
requests>=2.14.2 # Apache-2.0
|
requests>=2.14.2 # Apache-2.0
|
||||||
requestsexceptions>=1.2.0 # Apache-2.0
|
requestsexceptions>=1.2.0 # Apache-2.0
|
||||||
|
Loading…
x
Reference in New Issue
Block a user