Update to openstackdocstheme

oslosphinx is dead, convert to openstackdocstheme and update for
python3.

Change-Id: I4e5abc8485103f5b830759056db24185670c5ec2
This commit is contained in:
Andreas Jaeger 2020-06-01 15:45:22 +02:00 committed by Andreas Jaeger
parent ae6b370636
commit 9238dbe1c0
4 changed files with 14 additions and 19 deletions

View File

@ -24,12 +24,12 @@ 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',
] ]
# Feed configuration for yasfb # Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/{{cookiecutter.repo_name}}' feed_base_url = 'https://specs.openstack.org/openstack/{{cookiecutter.repo_name}}'
feed_author = 'OpenStack Development Team' feed_author = 'OpenStack Development Team'
exclude_patterns = [ exclude_patterns = [
@ -58,6 +58,11 @@ master_doc = 'index'
project = u'{{cookiecutter.repo_name}}' project = u'{{cookiecutter.repo_name}}'
copyright = u'%s, OpenStack Foundation' % datetime.date.today().year copyright = u'%s, OpenStack Foundation' % datetime.date.today().year
# openstackdocstheme options
openstackdocs_repo_name = '{{cookiecutter.repo_group}}/{{cookiecutter.repo_name}}'
openstackdocs_bug_project = '{{cookiecutter.bug_project}}'
openstackdocs_bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True add_function_parentheses = True
@ -66,7 +71,7 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
@ -75,6 +80,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

View File

@ -1,4 +1,4 @@
pbr>=2.0.0 pbr>=2.0.0
oslosphinx openstackdocstheme>=2.2.1 # Apache2
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
yasfb>=0.5.1 yasfb>=0.5.1

View File

@ -5,20 +5,9 @@ description-file =
README.rst README.rst
author = OpenStack author = OpenStack
author-email = openstack-discuss@lists.openstack.org author-email = openstack-discuss@lists.openstack.org
home-page = http://www.openstack.org/ home-page = https://www.openstack.org/
classifier = classifier =
Environment :: OpenStack Environment :: OpenStack
Intended Audience :: Developers Intended Audience :: Developers
License :: OSI Approved :: Apache Software License License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux Operating System :: POSIX :: Linux
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[pbr]
warnerrors = True
[upload_sphinx]
upload-dir = doc/build/html

View File

@ -1,11 +1,11 @@
[tox] [tox]
minversion = 1.6 minversion = 3.2.0
envlist = docs envlist = docs
skipsdist = True skipsdist = True
[testenv] [testenv]
basepython = python3
usedevelop = True usedevelop = True
install_command = pip install -U {opts} {packages}
setenv = setenv =
VIRTUAL_ENV={envdir} VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/requirements.txt deps = -r{toxinidir}/requirements.txt