openstack/python-dracclient
Code Issues Proposed changes

Merge "Switch from oslosphinx to openstackdocstheme"

Browse Source
This commit is contained in:
Zuul 2020-02-05 21:59:51 +00:00 committed by Gerrit Code Review
commit 44e66936e4
3 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
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 coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'oslosphinx' 'openstackdocstheme'
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -55,6 +55,7 @@ pygments_style = 'sphinx'
# html_theme_path = ["."] # html_theme_path = ["."]
# html_theme = '_theme' # html_theme = '_theme'
# html_static_path = ['static'] # html_static_path = ['static']
html_theme = 'openstackdocs'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project
@ -71,3 +72,6 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None} #intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
repository_name = 'openstack/python-dracclient'

5
test-requirements.txt
View File

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

5
tox.ini
View File

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