Browse Source

Switch to newer openstackdocstheme and reno versions

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* 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_name to use project as name.
Set openstackdocs_pdf_link to link to PDF file.

Remove docs requirements from lower-constraints, they are not installed.

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.

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

Change-Id: I320a69816b4101bb76b88448881f3177c892ea92
changes/45/728545/4
Andreas Jaeger 1 month ago
committed by Andreas Jaeger
parent
commit
7820cafffe
5 changed files with 18 additions and 18 deletions
  1. +4
    -4
      api-ref/source/conf.py
  2. +3
    -3
      doc/requirements.txt
  3. +6
    -5
      doc/source/conf.py
  4. +0
    -2
      lower-constraints.txt
  5. +5
    -4
      releasenotes/source/conf.py

+ 4
- 4
api-ref/source/conf.py View File

@@ -64,9 +64,9 @@ master_doc = 'index'
copyright = u'2010-present, OpenStack Foundation'

# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/keystone'
bug_project = 'keystone'
bug_tag = 'api-ref'
openstackdocs_repo_name = 'openstack/keystone'
openstackdocs_bug_project = 'keystone'
openstackdocs_bug_tag = 'api-ref'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -98,7 +98,7 @@ add_module_names = False
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 = []


+ 3
- 3
doc/requirements.txt View File

@@ -1,13 +1,13 @@
# 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.
openstackdocstheme>=1.20.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-apidoc>=0.2.0 # BSD
sphinxcontrib-seqdiag>=0.8.4 # BSD
sphinx-feature-classification>=0.3.2 # Apache-2.0
sphinxcontrib-blockdiag>=1.5.5 # BSD
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
python-ldap>=3.0.0 # PSF
ldappool>=2.0.0 # MPL

+ 6
- 5
doc/source/conf.py View File

@@ -114,7 +114,7 @@ exclude_patterns = ['old']
show_authors = True

# 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 = ['keystone.']
@@ -276,7 +276,8 @@ texinfo_documents = [
# intersphinx_mapping = {'http://docs.python.org/': None}

# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/keystone'
bug_project = 'keystone'
bug_tag = 'documentation'
openstack_projects = ['python-openstackclient']
openstackdocs_repo_name = 'openstack/keystone'
openstackdocs_bug_project = 'keystone'
openstackdocs_bug_tag = 'documentation'
openstackdocs_projects = ['python-openstackclient']
openstackdocs_pdf_link = True

+ 0
- 2
lower-constraints.txt View File

@@ -22,7 +22,6 @@ lxml==3.4.1
mock==2.0.0
msgpack==0.5.0
oauthlib==0.6.2
openstackdocstheme==1.20.0
os-api-ref==1.4.0
os-testr==1.0.0
oslo.cache==1.26.0
@@ -56,7 +55,6 @@ pytz==2013.6
requests==2.14.2
scrypt==0.8.0
six==1.10.0
Sphinx==1.6.5
sqlalchemy-migrate==0.11.0
SQLAlchemy==1.1.0
stestr==1.0.0


+ 5
- 4
releasenotes/source/conf.py View File

@@ -95,7 +95,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 = []
@@ -263,6 +263,7 @@ texinfo_documents = [
locale_dirs = ['locale/']

# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/keystone'
bug_project = 'keystone'
bug_tag = 'doc'
openstackdocs_auto_name = False
openstackdocs_repo_name = 'openstack/keystone'
openstackdocs_bug_project = 'keystone'
openstackdocs_bug_tag = 'doc'

Loading…
Cancel
Save