Switch to newer openstackdocstheme and reno versions
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. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. 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. Set openstackdocs_auto_name to use 'project' as name. 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: I5598eebe898555869cd65a74950fdbd76a7baa46
This commit is contained in:
		 Andreas Jaeger
					Andreas Jaeger
				
			
				
					committed by
					
						 Andreas Jaeger
						Andreas Jaeger
					
				
			
			
				
	
			
			
			 Andreas Jaeger
						Andreas Jaeger
					
				
			
						parent
						
							c588de4624
						
					
				
				
					commit
					3fa304428c
				
			| @@ -1,4 +1,4 @@ | |||||||
| 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 | ||||||
| sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD | sphinx>=2.0.0,!=2.1.0 # BSD | ||||||
| sphinxcontrib-httpdomain>=1.3.0  # BSD | sphinxcontrib-httpdomain>=1.3.0  # BSD | ||||||
|   | |||||||
| @@ -51,18 +51,8 @@ source_suffix = '.rst' | |||||||
| master_doc = 'index' | master_doc = 'index' | ||||||
|  |  | ||||||
| # General information about the project. | # General information about the project. | ||||||
| project = 'python-heatclient' |  | ||||||
| copyright = 'OpenStack Contributors' | copyright = '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. |  | ||||||
| version = '2.13' |  | ||||||
| # The full version, including alpha/beta/rc tags. |  | ||||||
| release = '2.13.0' |  | ||||||
|  |  | ||||||
| # 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. | ||||||
| # language = None | # language = None | ||||||
| @@ -93,7 +83,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 = [] | ||||||
| @@ -140,11 +130,6 @@ html_theme_options = { | |||||||
| # 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 = '%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 | ||||||
| @@ -261,6 +246,5 @@ texinfo_documents = [ | |||||||
| # texinfo_show_urls = 'footnote' | # texinfo_show_urls = 'footnote' | ||||||
|  |  | ||||||
| # -- Options for openstackdocstheme ------------------------------------------- | # -- Options for openstackdocstheme ------------------------------------------- | ||||||
| repository_name = 'openstack/python-heatclient' | openstackdocs_repo_name = 'openstack/python-heatclient' | ||||||
| bug_project = '997' | openstackdocs_use_storyboard = True | ||||||
| bug_tag = 'docs' |  | ||||||
|   | |||||||
| @@ -37,7 +37,6 @@ msgpack-python==0.4.0 | |||||||
| munch==2.1.0 | munch==2.1.0 | ||||||
| netaddr==0.7.18 | netaddr==0.7.18 | ||||||
| netifaces==0.10.4 | netifaces==0.10.4 | ||||||
| openstackdocstheme==1.18.1 |  | ||||||
| openstacksdk==0.11.2 | openstacksdk==0.11.2 | ||||||
| os-client-config==1.28.0 | os-client-config==1.28.0 | ||||||
| os-service-types==1.2.0 | os-service-types==1.2.0 | ||||||
| @@ -74,7 +73,6 @@ python-subunit==1.0.0 | |||||||
| python-swiftclient==3.2.0 | python-swiftclient==3.2.0 | ||||||
| pytz==2013.6 | pytz==2013.6 | ||||||
| PyYAML==3.12 | PyYAML==3.12 | ||||||
| reno==2.5.0 |  | ||||||
| requests-mock==1.2.0 | requests-mock==1.2.0 | ||||||
| requests==2.14.2 | requests==2.14.2 | ||||||
| requestsexceptions==1.2.0 | requestsexceptions==1.2.0 | ||||||
| @@ -82,8 +80,6 @@ rfc3986==0.3.1 | |||||||
| simplejson==3.5.1 | simplejson==3.5.1 | ||||||
| six==1.10.0 | six==1.10.0 | ||||||
| snowballstemmer==1.2.1 | snowballstemmer==1.2.1 | ||||||
| Sphinx==1.6.2 |  | ||||||
| sphinxcontrib-websupport==1.0.1 |  | ||||||
| stestr==2.0.0 | stestr==2.0.0 | ||||||
| stevedore==1.20.0 | stevedore==1.20.0 | ||||||
| tempest==17.1.0 | tempest==17.1.0 | ||||||
|   | |||||||
| @@ -47,9 +47,9 @@ extensions = [ | |||||||
| ] | ] | ||||||
|  |  | ||||||
| # openstackdocstheme options | # openstackdocstheme options | ||||||
| repository_name = 'openstack/python-heatclient' | openstackdocs_repo_name = 'openstack/python-heatclient' | ||||||
| bug_project = 'heat' | openstackdocs_use_storyboard = True | ||||||
| bug_tag = '' | openstackdocs_auto_name = False | ||||||
|  |  | ||||||
| # Add any paths that contain templates here, relative to this directory. | # Add any paths that contain templates here, relative to this directory. | ||||||
| templates_path = ['_templates'] | templates_path = ['_templates'] | ||||||
| @@ -91,7 +91,7 @@ language = None | |||||||
| exclude_patterns = [] | exclude_patterns = [] | ||||||
|  |  | ||||||
| # 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' | ||||||
|  |  | ||||||
| # If true, `todo` and `todoList` produce output, else they produce nothing. | # If true, `todo` and `todoList` produce output, else they produce nothing. | ||||||
| todo_include_todos = False | todo_include_todos = False | ||||||
| @@ -103,7 +103,6 @@ todo_include_todos = False | |||||||
| # a list of builtin themes. | # a list of builtin themes. | ||||||
| html_theme = 'openstackdocs' | html_theme = 'openstackdocs' | ||||||
|  |  | ||||||
| html_last_updated_fmt = '%Y-%m-%d %H:%M' |  | ||||||
| # Theme options are theme-specific and customize the look and feel of a theme | # Theme options are theme-specific and customize the look and feel of a theme | ||||||
| # further.  For a list of options available for each theme, see the | # further.  For a list of options available for each theme, see the | ||||||
| # documentation. | # documentation. | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user