openstack/openstack-ansible
Code Issues Proposed changes

Merge "Switch to newer openstackdocstheme and reno versions"

Browse Source
This commit is contained in:
Zuul 2020-06-05 12:10:46 +00:00 committed by Gerrit Code Review
commit 4f5816fc51
4 changed files with 16 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
deploy-guide/source/conf.py
View File

@ -114,9 +114,9 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/' + target_name openstackdocs_repo_name = 'openstack/' + target_name
bug_project = 'openstack-ansible' openstackdocs_bug_project = 'openstack-ansible'
bug_tag = '' openstackdocs_bug_tag = ''
# 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.
@ -196,10 +196,6 @@ html_theme = 'openstackdocs'
# directly to the root of the documentation. # directly to the root of the documentation.
# html_extra_path = [] # html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
# html_use_smartypants = True # html_use_smartypants = True
@ -305,7 +301,7 @@ man_pages = [
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, target_name, (master_doc, target_name,
title, author, bug_project, title, author, openstackdocs_bug_project,
description, category), description, category),
] ]

6
doc/requirements.txt
View File

@ -3,9 +3,9 @@
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
# this is required for the docs build jobs # this is required for the docs build jobs
sphinx>=1.8.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
openstackdocstheme>=1.29.2 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
reno>=2.11.3 # Apache-2.0 reno>=3.1.0 # Apache-2.0
doc8>=0.8.0 # Apache-2.0 doc8>=0.8.0 # Apache-2.0
bashate>=0.6.0 # Apache-2.0 bashate>=0.6.0 # Apache-2.0

13
doc/source/conf.py
View File

@ -128,10 +128,11 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/' + target_name openstackdocs_repo_name = 'openstack/' + target_name
openstackdocs_pdf_link = True
# The bug project is always the same for all our repos # The bug project is always the same for all our repos
bug_project = 'openstack-ansible' openstackdocs_bug_project = 'openstack-ansible'
bug_tag = '' openstackdocs_bug_tag = ''
# 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.
@ -215,10 +216,6 @@ html_static_path = ['_static']
# directly to the root of the documentation. # directly to the root of the documentation.
# html_extra_path = [] # html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
# html_use_smartypants = True # html_use_smartypants = True
@ -326,7 +323,7 @@ man_pages = [
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, target_name, (master_doc, target_name,
title, author, bug_project, title, author, openstackdocs_bug_project,
description, category), description, category),
] ]

11
releasenotes/source/conf.py
View File

@ -74,9 +74,10 @@ release = ''
# The short X.Y version. # The short X.Y version.
version = '' version = ''
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/' + target_name openstackdocs_repo_name = 'openstack/' + target_name
bug_project = project.lower() openstackdocs_auto_name = False
bug_tag = '' openstackdocs_bug_project = project.lower()
openstackdocs_bug_tag = ''
# 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.
@ -157,10 +158,6 @@ html_static_path = ['_static']
# directly to the root of the documentation. # directly to the root of the documentation.
# html_extra_path = [] # html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
# html_use_smartypants = True # html_use_smartypants = True