Use openstackdocstheme over oslosphinx
This commit is part of general doc-migration effort. It replaces oslosphinx with openstackdocstheme and marks docs warnings to be treated as errors. Kuryr projects do not seem to have any docs in the openstack-manuals, so there are no docs we need to pull from that repo. However being the official project kuryr would benefit from unifying its docs with the rest of openstack projects as well as using openstackdocstheme, theme intended for official projects https://docs.openstack.org/openstackdocstheme/latest/ See https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html and https://etherpad.openstack.org/p/doc-migration-tracking for more information Change-Id: I1fc7decf5fb247a2832d8b89d79231cb4e4be039
This commit is contained in:
parent
eaba8339f3
commit
f63d3b24a8
|
@ -23,8 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.todo',
|
||||
#'sphinx.ext.intersphinx',
|
||||
'oslosphinx'
|
||||
'openstackdocstheme'
|
||||
]
|
||||
|
||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||
|
@ -41,6 +40,12 @@ master_doc = 'index'
|
|||
project = u'kuryr-kubernetes'
|
||||
copyright = u'2013, OpenStack Foundation'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/kuryr-kubernetes'
|
||||
bug_project = 'kuryr-kubernetes'
|
||||
bug_tag = ''
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
add_function_parentheses = True
|
||||
|
||||
|
@ -56,7 +61,7 @@ pygments_style = 'sphinx'
|
|||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||
# html_theme_path = ["."]
|
||||
# html_theme = '_theme'
|
||||
html_theme = 'openstackdocs'
|
||||
# html_static_path = ['static']
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
|
|
|
@ -78,6 +78,7 @@ packages =
|
|||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
all_files = 1
|
||||
warning-is-error = 1
|
||||
|
||||
[upload_sphinx]
|
||||
upload-dir = doc/build/html
|
||||
|
|
|
@ -11,7 +11,7 @@ mock>=2.0 # BSD
|
|||
python-subunit>=0.0.18 # Apache-2.0/BSD
|
||||
sphinx>=1.6.2 # BSD
|
||||
os-testr>=0.8.0 # Apache-2.0
|
||||
oslosphinx>=4.7.0 # Apache-2.0
|
||||
openstackdocstheme>=1.11.0 # Apache-2.0
|
||||
oslotest>=1.10.0 # Apache-2.0
|
||||
testrepository>=0.0.18 # Apache-2.0/BSD
|
||||
testscenarios>=0.4 # Apache-2.0/BSD
|
||||
|
|
Loading…
Reference in New Issue