openstack
/
security-doc
Code Issues Proposed changes

Switch to newer openstackdocstheme version 

Switch to openstackdocstheme 2.1.1 version. Using
ths version will allow parallelizing building of documents.

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Set openstackdocs_auto_version to not version the documents.
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.

Remove 0.0.1 version from security-thread-analysis.

Change-Id: Idd9c795d97ee33e4f121c5b4b97a9ee9e38ae50e
This commit is contained in:
Andreas Jaeger 2020-05-14 21:36:13 +02:00
parent ee003461be
commit 1d5f436400
3 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
security-guide/source/conf.py
View File

@ -44,11 +44,13 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name = 'openstack/security-doc'
openstackdocs_repo_name = 'openstack/security-doc'
project = u'Security Guide'
bug_tag = u'sec-guide'
bug_project = u'ossp-security-documentation'
openstackdocs_bug_tag = u'sec-guide'
openstackdocs_bug_project = u'ossp-security-documentation'
copyright = u'2015-2017, OpenStack contributors'
openstackdocs_auto_version = False
openstackdocs_auto_name = False
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -89,7 +91,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 = []

14
security-threat-analysis/source/conf.py
View File

@ -44,20 +44,22 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name = 'openstack/security-doc'
openstackdocs_repo_name = 'openstack/security-doc'
project = u'Security Threat Analysis'
bug_project = 'ossp-security-documentation'
bug_tag = u'threat-analysis'
openstackdocs_bug_project = 'ossp-security-documentation'
openstackdocs_bug_tag = u'threat-analysis'
copyright = u'2016-2017, OpenStack contributors'
openstackdocs_auto_version = False
openstackdocs_auto_name = False
# 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 = '0.0.1'
version = ''
# The full version, including alpha/beta/rc tags.
release = '0.0.1'
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -89,7 +91,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 = []

4
test-requirements.txt
View File

@ -4,8 +4,8 @@
doc8 # Apache-2.0
openstack-doc-tools>=2.0.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2' # BSD
openstackdocstheme>=1.31.2 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.1.1 # Apache-2.0
# For translations
Babel>=2.3.4,!=2.4.0 # BSD