openstack/trove-specs
Code Issues Proposed changes

docs: Resolve issues with Sphinx 2.0

Browse Source 
switch to openstackdocstheme which, unlike
the EOL'd oslosphinx theme, supports Sphinx 2.0.

Change-Id: I27e8612872830d55e0aed309f23194656fcc9369
ref: https://docs.openstack.org/openstackdocstheme/latest/
This commit is contained in:
Minmin Ren 2019-05-23 10:02:08 +00:00
parent 4eb3b2515f
commit 2dddc9c109
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/conf.py
View File

@ -23,10 +23,16 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
'oslosphinx', 'openstackdocstheme',
'yasfb', 'yasfb',
] ]
# openstackdocstheme options
repository_name = 'openstack/trove-specs'
bug_project = 'trove-specs'
bug_tag = 'doc'
# Optionally allow the use of sphinxcontrib.spelling to verify the # Optionally allow the use of sphinxcontrib.spelling to verify the
# spelling of the documents. # spelling of the documents.
try: try:
@ -70,6 +76,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

6
requirements.txt
View File

@ -1,6 +1,6 @@
pbr>=0.6,<1.0 openstackdocstheme>=1.11.0
oslosphinx sphinx!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.1.2,<1.2 sphinx!=1.6.6,!=1.6.7;python_version>='3.4' # BSD
testrepository>=0.0.18 testrepository>=0.0.18
testtools>=0.9.34 testtools>=0.9.34
yasfb>=0.5.1 yasfb>=0.5.1