openstack/python-tackerclient
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Iafe611a36e17869bf17f5b2c016ef7c22fb36eb3
This commit is contained in:
Andreas Jaeger 2020-05-18 22:53:05 +02:00 committed by Andreas Jaeger
parent 0af84c52cd
commit c7b5925451
3 changed files with 13 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -2,6 +2,6 @@
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
# These are needed for docs generation # These are needed for docs generation
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0

12
doc/source/conf.py
View File

@ -44,7 +44,6 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = 'python-tackerclient'
copyright = 'OpenStack Contributors' copyright = 'OpenStack Contributors'
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
@ -55,7 +54,7 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
@ -68,7 +67,6 @@ htmlhelp_basename = 'tackerclientdoc'
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# -- Options for manual page output ------------------------------------------- # -- Options for manual page output -------------------------------------------
@ -79,10 +77,10 @@ man_pages = [
# -- Options for openstackdocstheme ------------------------------------------- # -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/python-tackerclient' openstackdocs_repo_name = 'openstack/python-tackerclient'
bug_project = 'python-tackerclient' openstackdocs_bug_project = 'python-tackerclient'
bug_tag = 'doc' openstackdocs_bug_tag = 'doc'
# -- Options for cliff.sphinxext plugin --------------------------------------- # -- Options for cliff.sphinxext plugin ---------------------------------------
autoprogram_cliff_application = 'openstack' autoprogram_cliff_application = 'openstack'

13
releasenotes/source/conf.py
View File

@ -90,7 +90,7 @@ exclude_patterns = []
# show_authors = False # show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
# modindex_common_prefix = [] # modindex_common_prefix = []
@ -131,10 +131,6 @@ html_theme = 'openstackdocs'
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
# 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
@ -259,6 +255,7 @@ texinfo_documents = [
locale_dirs = ['locale/'] locale_dirs = ['locale/']
# -- Options for openstackdocstheme ------------------------------------------- # -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/python-tackerclient' openstackdocs_repo_name = 'openstack/python-tackerclient'
bug_project = 'python-tackerclient' openstackdocs_bug_project = 'python-tackerclient'
bug_tag = '' openstackdocs_bug_tag = ''
openstackdocs_auto_name = False