diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-06-02 13:59:02 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-06-02 14:00:56 +0200 |
| commit | b3613ff708844f2b7cb30976e904af96ae3981ed (patch) | |
| tree | d12fca6e020e8edc8b6e89b58e1390ae3a8fafc9 | |
| parent | d6b4ed4c7bb251e4378b4eab836e8798a83c75dc (diff) | |
| download | ceilometermiddleware-b3613ff708844f2b7cb30976e904af96ae3981ed.tar.gz | |
Switch to newer openstackdocstheme and reno versionsvictoria-em2.1.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.
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: I7966fa4281dde7e6340d632333ea8f8b84128bde
| -rw-r--r-- | doc/source/conf.py | 7 | ||||
| -rw-r--r-- | releasenotes/source/conf.py | 12 | ||||
| -rw-r--r-- | test-requirements.txt | 4 |
3 files changed, 10 insertions, 13 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 582c805..eb3c34c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -48,7 +48,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' # -- Options for HTML output -------------------------------------------------- @@ -77,5 +77,6 @@ latex_documents = [ #intersphinx_mapping = {'http://docs.python.org/': None} # openstackdocstheme options -repository_name = 'openstack/ceilometermiddleware' -bug_project = 'http://bugs.launchpad.net/ceilometermiddleware' +openstackdocs_repo_name = 'openstack/ceilometermiddleware' +openstackdocs_auto_name = False +openstackdocs_use_storyboard = True diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 667a130..d3ca192 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -68,9 +68,9 @@ release = '' version = '' # openstackdocstheme options -repository_name = 'openstack/ceilometermiddleware' -bug_project = 'ceilometermiddleware' -bug_tag = '' +openstackdocs_repo_name = 'openstack/ceilometermiddleware' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -102,7 +102,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 = [] @@ -151,10 +151,6 @@ html_static_path = ['_static'] # directly to the root of the documentation. # 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 # typographically correct entities. # html_use_smartypants = True diff --git a/test-requirements.txt b/test-requirements.txt index 261e8c8..d82a2b7 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,8 +5,8 @@ coverage>=3.6 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD sphinx>=2.0.0,!=2.1.0 # BSD -openstackdocstheme>=2.0.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 stestr>=2.0.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 betamax>=0.7.0 # Apache-2.0 |