Browse Source

Switch from oslosphinx to openstackdocstheme

That's what the OpenStack community is using today. Also with newer
Sphinx versions, the current approach does no longer build.

Change-Id: Iab9f72bb146e8dd36de7fa868b41801e0c97e2ea
(cherry picked from commit b4c304c5d6)
tags/1.7.0
Thomas Bechtold 9 months ago
committed by Christopher Dearborn
parent
commit
841edfb863
3 changed files with 11 additions and 5 deletions
  1. +5
    -1
      doc/source/conf.py
  2. +3
    -2
      test-requirements.txt
  3. +3
    -2
      tox.ini

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

@@ -21,7 +21,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'oslosphinx'
'openstackdocstheme'
]

# autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -55,6 +55,7 @@ pygments_style = 'sphinx'
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
html_theme = 'openstackdocs'

# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
@@ -71,3 +72,6 @@ latex_documents = [

# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}

# openstackdocstheme options
repository_name = 'openstack/python-dracclient'

+ 3
- 2
test-requirements.txt View File

@@ -7,5 +7,6 @@ doc8
hacking>=0.11.0,<0.12
mock>=2.0
requests-mock>=1.0
sphinx>=1.2.1,!=1.3b1,<1.3
oslosphinx>=2.5.0,!=3.4.0
sphinx!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,!=2.1.0;python_version>='3.4' # BSD
openstackdocstheme # Apache-2.0

+ 3
- 2
tox.ini View File

@@ -25,8 +25,9 @@ commands =
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/stable/queens/upper-constraints.txt}
-r{toxinidir}/requirements.txt
-r{toxinidir}/doc/requirements.txt
commands = python setup.py build_sphinx
-r{toxinidir}/test-requirements.txt
commands =
sphinx-build -b html doc/source doc/build/html

[flake8]
max-complexity=15


Loading…
Cancel
Save