openstack/ui-cookiecutter
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.

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.
Do not set version for releasenotes, they are always unversioned.

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

Change-Id: Ia2fa8ed0001da2696c87253ad2251260a4a90882
This commit is contained in:
Andreas Jaeger 2020-05-26 08:44:53 +02:00
parent d3bc715b79
commit 3b5d1a5de3
3 changed files with 14 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
{{cookiecutter.repo_name}}/doc/requirements.txt
View File

@ -8,7 +8,7 @@
#
# Requirements for docs
mock>=2.0.0 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD

13
{{cookiecutter.repo_name}}/doc/source/conf.py
View File

@ -22,8 +22,6 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
from __future__ import print_function
import os
import sys
@ -115,7 +113,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 = []
@ -137,9 +135,9 @@ apidoc_excluded_paths = [
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
bug_project = '{{cookiecutter.launchpad_project}}'
bug_tag = ''
openstackdocs_repo_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
openstackdocs_bug_project = '{{cookiecutter.launchpad_project}}'
openstackdocs_bug_tag = ''
# 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
@ -170,9 +168,6 @@ bug_tag = ''
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# Must set this variable to include year, month, day, hours, and minutes.
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

18
{{cookiecutter.repo_name}}/releasenotes/source/conf.py
View File

@ -11,8 +11,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
from {{cookiecutter.module_name}} import version as ui_ver
# This file is execfile()d with the current directory set to its
# containing dir.
#
@ -62,9 +60,9 @@ copyright = u'2017, OpenStack Foundation'
#
# The short X.Y version.
# The full version, including alpha/beta/rc tags.
release = ui_ver.version_info.release_string()
release = ''
# The short X.Y version.
version = ui_ver.version_info.version_string()
version = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -96,7 +94,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 = []
@ -112,9 +110,10 @@ pygments_style = 'sphinx'
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
bug_project = '{{cookiecutter.launchpad_project}}'
bug_tag = ''
openstackdocs_repo_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
openstackdocs_auto_name = False
openstackdocs_bug_project = '{{cookiecutter.launchpad_project}}'
openstackdocs_bug_tag = ''
# 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
@ -150,9 +149,6 @@ bug_tag = ''
# directly to the root of the documentation.
# html_extra_path = []
# Must set this variable to include year, month, day, hours, and minutes.
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