Переглянути джерело

Switch to openstackdocstheme

Update to use current openstackdocstheme everywhere instead of
oslosphinx, remove now obsolete settings.

Change-Id: I812f72ebf9fb4d96b1031880c44596833da9d384
tags/1.6.0
Andreas Jaeger 2 роки тому
джерело
коміт
c3bf1aa507
3 змінених файлів з 11 додано та 22 видалено
  1. +5
    -18
      doc/source/conf.py
  2. +6
    -3
      releasenotes/source/conf.py
  3. +0
    -1
      test-requirements.txt

+ 5
- 18
doc/source/conf.py Переглянути файл

@@ -14,8 +14,6 @@
import os
import sys

import openstackdocstheme

sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------

@@ -23,8 +21,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
# 'sphinx.ext.intersphinx',
# 'oslo.sphinx'
'openstackdocstheme'
]

# autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -38,20 +35,10 @@ source_suffix = '.rst'
master_doc = 'index'

# General information about the project.
project = u'openstack-doc-tools'
copyright = u'2017, OpenStack Foundation'

# A few variables have to be set for the log-a-bug feature.
# giturl: The location of conf.py on Git. Must be set manually.
# gitsha: The SHA checksum of the bug description. Automatically extracted from git log.
# bug_tag: Tag for categorizing the bug. Must be set manually.
# These variables are passed to the logabug code via html_context.
giturl = u'https://git.openstack.org/cgit/openstack/openstack-doc-tools/tree/doc/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
repository_name = 'openstack/openstack-doc-tools'
bug_tag = u'openstack-doc-tools'
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
project = u'OpenStack-doc-tools'
copyright = u'2017, OpenStack Foundation'

# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@@ -70,7 +57,7 @@ pygments_style = 'sphinx'
html_theme = 'openstackdocs'

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# html_theme_path = [openstackdocstheme.get_html_theme_path()]

# html_static_path = ['static']


+ 6
- 3
releasenotes/source/conf.py Переглянути файл

@@ -35,7 +35,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'oslosphinx',
'openstackdocstheme',
'reno.sphinxext',
]

@@ -52,8 +52,10 @@ source_suffix = '.rst'
master_doc = 'index'

# General information about the project.
repository_name = 'openstack/openstack-doc-tools'
bug_tag = u'openstack-doc-tools'
project = u'OpenStack-doc-tools Release Notes'
copyright = u'2015, OpenStack Documentation team'
copyright = u'2015-2017, OpenStack Documentation team'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -109,7 +111,7 @@ pygments_style = 'sphinx'

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'openstackdocs'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -148,6 +150,7 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
html_last_updated_fmt = '%Y-%m-%d %H:%M'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.

+ 0
- 1
test-requirements.txt Переглянути файл

@@ -12,7 +12,6 @@ pylint==1.7.1 # GPLv2

reno!=2.3.1,>=1.8.0 # Apache-2.0
openstackdocstheme>=1.11.0 # Apache-2.0
oslosphinx>=4.7.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD

# mock object framework

Завантаження…
Відмінити
Зберегти