diff options
author | Andreas Jaeger <aj@suse.com> | 2020-06-02 13:52:34 +0200 |
---|---|---|
committer | Andreas Jaeger <aj@suse.com> | 2020-06-02 13:54:29 +0200 |
commit | 13c1165779f3cce7e1be301521866f15adff4751 (patch) | |
tree | 8347f8999cbda108fa12e4dcdd9385fe09aedf3a | |
parent | c734b8ede71e8cb0aaeacc610c08b639e0914805 (diff) | |
download | taskflow-13c1165779f3cce7e1be301521866f15adff4751.tar.gz |
Switch to newer openstackdocstheme and reno versions4.2.0
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.
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.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Ieb7ce05f6611ad743336a35065402888176c7de3
-rw-r--r-- | doc/requirements.txt | 6 | ||||
-rw-r--r-- | doc/source/conf.py | 9 | ||||
-rw-r--r-- | lower-constraints.txt | 2 | ||||
-rw-r--r-- | releasenotes/source/conf.py | 10 |
4 files changed, 13 insertions, 14 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index f5b2c7f..5984ff0 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,7 +1,7 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index aebfde7..f30aa41 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -16,9 +16,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/taskflow' -bug_project = 'taskflow' -bug_tag = '' +openstackdocs_repo_name = 'openstack/taskflow' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'taskflow' +openstackdocs_bug_tag = '' # Add any paths that contain templates here, relative to this directory. templates_path = ['templates'] @@ -45,7 +46,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # Prefixes that are ignored for sorting the Python module index modindex_common_prefix = ['taskflow.'] diff --git a/lower-constraints.txt b/lower-constraints.txt index 1e780da..73e4186 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -62,8 +62,6 @@ requestsexceptions==1.2.0 restructuredtext-lint==1.1.1 six==1.10.0 snowballstemmer==1.2.1 -Sphinx==1.6.2 -sphinxcontrib-websupport==1.0.1 SQLAlchemy-Utils==0.30.11 SQLAlchemy==1.0.10 stevedore==1.20.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index b0cf819..58a9b3b 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -43,10 +43,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/taskflow' -bug_project = 'taskflow' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/taskflow' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'taskflow' +openstackdocs_bug_tag = '' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -101,7 +101,7 @@ exclude_patterns = [] # show_authors = False # 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. # modindex_common_prefix = [] |