diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-30 17:06:22 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-05-30 17:07:03 +0200 |
| commit | d5f9e98a57ff5b0bd7363f49be8735e4087335ba (patch) | |
| tree | beead5520f0123d8525591f3b8b2d38a54e0dfb5 | |
| parent | e3457fcf7d1c8fe5df7610094cf3c0e4262adeb1 (diff) | |
| download | heat-cfntools-d5f9e98a57ff5b0bd7363f49be8735e4087335ba.tar.gz | |
Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable 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.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I3c41f2e7a7b9b0f6ab871da93540737b61ba857f
| -rw-r--r-- | doc/requirements.txt | 4 | ||||
| -rw-r--r-- | doc/source/conf.py | 17 |
2 files changed, 6 insertions, 15 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 0b15abb..f80adec 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,3 +1,3 @@ -openstackdocstheme>=1.11.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-httpdomain>=1.7.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index fa24424..764df86 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -60,15 +60,6 @@ master_doc = 'index' project = 'heat-cfntools' copyright = 'OpenStack Foundation' -# 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 = '' -# The full version, including alpha/beta/rc tags. -release = '' - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # @@ -82,7 +73,7 @@ language = None exclude_patterns = [] # 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. # todo_include_todos = False @@ -114,9 +105,9 @@ html_theme = 'openstackdocs' # html_sidebars = {} # -- Options for openstackdocstheme -------------------------------------- -repository_name = 'openstack/heat-cfntools' -bug_project = '991' -bug_tag = 'docs' +openstackdocs_repo_name = 'openstack/heat-cfntools' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True # -- Options for HTMLHelp output ------------------------------------------ |