From 9238dbe1c09bcfeb14c0577ba13d3e64b6eba82d Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 1 Jun 2020 15:45:22 +0200 Subject: [PATCH] Update to openstackdocstheme oslosphinx is dead, convert to openstackdocstheme and update for python3. Change-Id: I4e5abc8485103f5b830759056db24185670c5ec2 --- {{cookiecutter.repo_name}}/doc/source/conf.py | 12 +++++++++--- {{cookiecutter.repo_name}}/requirements.txt | 4 ++-- {{cookiecutter.repo_name}}/setup.cfg | 13 +------------ {{cookiecutter.repo_name}}/tox.ini | 4 ++-- 4 files changed, 14 insertions(+), 19 deletions(-) diff --git a/{{cookiecutter.repo_name}}/doc/source/conf.py b/{{cookiecutter.repo_name}}/doc/source/conf.py index 18618e7..c2134ec 100755 --- a/{{cookiecutter.repo_name}}/doc/source/conf.py +++ b/{{cookiecutter.repo_name}}/doc/source/conf.py @@ -24,12 +24,12 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx', + 'openstackdocstheme', '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' exclude_patterns = [ @@ -58,6 +58,11 @@ master_doc = 'index' project = u'{{cookiecutter.repo_name}}' 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. add_function_parentheses = True @@ -66,7 +71,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- @@ -75,6 +80,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 diff --git a/{{cookiecutter.repo_name}}/requirements.txt b/{{cookiecutter.repo_name}}/requirements.txt index e5567e9..5159c9e 100644 --- a/{{cookiecutter.repo_name}}/requirements.txt +++ b/{{cookiecutter.repo_name}}/requirements.txt @@ -1,4 +1,4 @@ pbr>=2.0.0 -oslosphinx -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=2.2.1 # Apache2 +sphinx>=2.0.0,!=2.1.0 # BSD yasfb>=0.5.1 diff --git a/{{cookiecutter.repo_name}}/setup.cfg b/{{cookiecutter.repo_name}}/setup.cfg index 3253d23..064830b 100644 --- a/{{cookiecutter.repo_name}}/setup.cfg +++ b/{{cookiecutter.repo_name}}/setup.cfg @@ -5,20 +5,9 @@ description-file = README.rst author = OpenStack author-email = openstack-discuss@lists.openstack.org -home-page = http://www.openstack.org/ +home-page = https://www.openstack.org/ classifier = Environment :: OpenStack Intended Audience :: Developers License :: OSI Approved :: Apache Software License 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 diff --git a/{{cookiecutter.repo_name}}/tox.ini b/{{cookiecutter.repo_name}}/tox.ini index 88f46ad..1a89593 100644 --- a/{{cookiecutter.repo_name}}/tox.ini +++ b/{{cookiecutter.repo_name}}/tox.ini @@ -1,11 +1,11 @@ [tox] -minversion = 1.6 +minversion = 3.2.0 envlist = docs skipsdist = True [testenv] +basepython = python3 usedevelop = True -install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} deps = -r{toxinidir}/requirements.txt