openstack
/
openstack-manuals
Code Issues Proposed changes

Simplify conf.py for openstackdocstheme 1.11.0 

With the new openstackdocstheme used, we can simplify conf.py.

Also, update our docs for it.

Note that Sphinx 1.6 needs latexmk for building, add it.

Sphinx 1.6 introduces a few new warnings, fix them so that the guides
built.

Change-Id: If2e431725eb54f8be79b9fa4bf9ede2089f321a5
This commit is contained in:
Andreas Jaeger 2017-06-26 21:25:58 +02:00
parent b2ff0cf9a3
commit b1bad0d43a
19 changed files with 65 additions and 225 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
bindep.txt
View File

@ -19,3 +19,4 @@ texlive-latex-base [platform:dpkg]
texlive-latex-extra [platform:dpkg]
texlive-xetex [platform:dpkg]
texlive-fonts-recommended [platform:dpkg]
latexmk [platform:dpkg]

18
doc/admin-guide/source/conf.py
View File

@ -24,8 +24,6 @@ import os
# import sys
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -39,7 +37,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# extensions =
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -54,6 +52,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Administrator Guide'
bug_tag = u'admin-guide'
copyright = u'2015-2017, OpenStack contributors'
@ -67,17 +66,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/admin-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -130,7 +118,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

20
doc/arch-design-to-archive/source/conf.py
View File

@ -23,8 +23,6 @@
import os
# import sys
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -38,7 +36,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# extensions = ['sphinx.ext.todo']
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -53,9 +51,10 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Architecture Design Guide'
bug_tag = u'arch-design-to-archive'
copyright = u'2015-2016, OpenStack contributors'
copyright = u'2015-2017, OpenStack contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -66,17 +65,6 @@ version = '0.9'
# The full version, including alpha/beta/rc tags.
release = '0.9'
# 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-manuals/tree/doc/arch-design-rst/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -128,7 +116,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

16
doc/arch-design/source/conf.py
View File

@ -39,7 +39,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# extensions = []
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -54,6 +54,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Architecture Design Guide'
bug_tag = u'arch-design'
copyright = u'2015-2017, OpenStack contributors'
@ -67,17 +68,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/arch-design/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -129,7 +119,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

18
doc/cli-reference/source/conf.py
View File

@ -29,8 +29,6 @@ sys.path.append(os.path.dirname(__file__))
# "RuntimeError: maximum recursion depth exceeded in cmp" issue.
sys.setrecursionlimit(4000)
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -44,7 +42,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# extensions = ['']
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -59,6 +57,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Command-Line Interface Reference'
bug_tag = u'cli-reference'
copyright = u'2015-2017, OpenStack contributors'
@ -72,17 +71,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/cli-reference/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -134,7 +122,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

16
doc/common/source/conf.py
View File

@ -24,8 +24,6 @@ import os
# import sys
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -39,7 +37,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -54,6 +52,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Common documents'
bug_tag = u'common'
@ -68,17 +67,6 @@ version = '1.0.0'
# The full version, including alpha/beta/rc tags.
release = '1.0.0'
# 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-manuals/tree/doc/common/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None

13
doc/config-reference/source/block-storage/drivers/dell-emc-unity-driver.rst
View File

@ -278,9 +278,11 @@ connect this snapshot to the Block Storage host for volume backup.
Troubleshooting
~~~~~~~~~~~~~~~
To troubleshoot a failure in OpenStack deployment, the best way is to enable
verbose and debug log, at the same time, leverage the build-in [request_id]_ to
track specific Block Storage command logs.
To troubleshoot a failure in OpenStack deployment, the best way is to
enable verbose and debug log, at the same time, leverage the build-in
`Return request ID to caller
<https://specs.openstack.org/openstack/openstack-specs/specs/return-request-id.html>`_
to track specific Block Storage command logs.
#. Enable verbose log, set following in ``/etc/cinder/cinder.conf`` and restart
@ -335,8 +337,3 @@ track specific Block Storage command logs.
# grep "req-3a459e0e-871a-49f9-9796-b63cc48b5015" cinder-volume.log
.. [request_id] `Return request ID to caller
<https://specs.openstack.org/openstack/openstack-specs/specs/return-request-id.html>`_

20
doc/config-reference/source/conf.py
View File

@ -25,8 +25,6 @@ import sys
sys.path.append(os.path.dirname(__file__))
import openstackdocstheme
# Avoid unactionable warnings
import requestsexceptions
requestsexceptions.squelch_warnings(requestsexceptions.InsecureRequestWarning)
@ -44,7 +42,9 @@ requestsexceptions.squelch_warnings(requestsexceptions.InsecureRequestWarning)
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['ext.remote', 'sphinxmark']
extensions = ['ext.remote',
'sphinxmark',
'openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -59,6 +59,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Configuration Reference'
bug_tag = u'config-reference'
copyright = u'2015-2017, OpenStack contributors'
@ -72,17 +73,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/config-reference/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -134,7 +124,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

14
doc/contributor-guide/source/api-guides.rst
View File

@ -93,19 +93,25 @@ The basic steps are:
include the html theme, openstackdocstheme, use the os-api-ref Sphinx
extension, and also point the bug reporting link to your project's repo::
import openstackdocstheme
extensions = [
'os_api_ref',
'openstackdocstheme'
]
# The prefix and repo name like
repository_name = 'openstack/glance'
# Set Launchpad bug tag, default is empty
bug_tag = ''
# The launchpad project name like
bug_project = 'glance'
html_theme = 'openstackdocs'
html_theme_path = [openstackdocstheme.get_html_theme_path()]
html_theme_options = {
"sidebar_mode": "toc",
}
html_context = {'bug_project': 'nova', 'bug_tag': 'api-ref'}
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
#. Update the ``test-requirements.txt`` file for the project with a line for
the ``os-api-ref`` Sphinx extension::

18
doc/contributor-guide/source/conf.py
View File

@ -24,8 +24,6 @@ import os
# import sys
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -39,7 +37,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
@ -55,6 +53,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Contributor Guide'
bug_tag = u'contributor-guide'
@ -70,17 +69,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/contributor-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -136,7 +124,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

18
doc/ha-guide-draft/source/conf.py
View File

@ -23,8 +23,6 @@
import os
# import sys
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -38,7 +36,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -53,6 +51,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'High Availability Guide Draft'
bug_tag = u'ha-guide-draft'
copyright = u'2017, OpenStack contributors'
@ -66,17 +65,6 @@ version = '0.0.1'
# The full version, including alpha/beta/rc tags.
release = '0.0.1'
# 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-manuals/tree/doc/ha-guide-draft/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -129,7 +117,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

16
doc/ha-guide/source/conf.py
View File

@ -38,7 +38,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# extensions = []
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -53,6 +53,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'High Availability Guide'
bug_tag = u'ha-guide'
copyright = u'2015-2017, OpenStack contributors'
@ -66,17 +67,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/ha-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -130,7 +120,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

16
doc/image-guide/source/conf.py
View File

@ -38,7 +38,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# extensions = []
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -53,6 +53,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Virtual Machine Image Guide'
bug_tag = u'image-guide'
copyright = u'2015-2017, OpenStack contributors'
@ -66,17 +67,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/image-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -129,7 +119,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

17
doc/install-guide/source/conf.py
View File

@ -23,7 +23,6 @@
import os
# import sys
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
@ -39,7 +38,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinxmark']
extensions = ['sphinxmark', 'openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -54,6 +53,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Installation Guide'
bug_tag = u'install-guide'
copyright = u'2015-2017, OpenStack contributors'
@ -67,17 +67,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/install-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -141,7 +130,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

18
doc/networking-guide/source/conf.py
View File

@ -38,7 +38,9 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.todo', 'sphinxmark']
extensions = ['sphinx.ext.todo',
'sphinxmark',
'openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -53,6 +55,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Networking Guide'
bug_tag = u'networking-guide'
copyright = u'2015-2017, OpenStack contributors'
@ -66,17 +69,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/networking-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -128,7 +120,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

16
doc/ops-guide/source/conf.py
View File

@ -38,7 +38,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -53,6 +53,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'Operations Guide'
bug_tag = u'ops-guide'
copyright = u'2016-2017, OpenStack contributors'
@ -66,17 +67,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/ops-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -130,7 +120,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

16
doc/user-guide/source/conf.py
View File

@ -38,7 +38,7 @@ import openstackdocstheme
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# extensions = []
extensions = ['openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -53,6 +53,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name="openstack/openstack-manuals"
project = u'End User Guide'
bug_tag = u'user-guide'
@ -67,17 +68,6 @@ version = '15.0'
# The full version, including alpha/beta/rc tags.
release = '15.0.0'
# 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-manuals/tree/doc/user-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -129,7 +119,7 @@ html_theme = 'openstackdocs'
# html_theme_options = {}
# 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()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".

17
releasenotes/source/conf.py
View File

@ -23,8 +23,6 @@
import os
# import sys
import openstackdocstheme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -40,6 +38,7 @@ import openstackdocstheme
# ones.
extensions = [
'reno.sphinxext',
'openstackdocstheme'
]
# Add any paths that contain templates here, relative to this directory.
@ -56,6 +55,7 @@ master_doc = 'index'
# General information about the project.
project = u'OpenStack Documentation Team Release Notes'
repository_name="openstack/openstack-manuals"
bug_tag = u'releasenotes'
copyright = u'2016, OpenStack contributors'
@ -68,16 +68,6 @@ version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# 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-manuals/tree/doc/releasenotes/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -129,9 +119,6 @@ html_theme = 'openstackdocs'
# documentation.
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [openstackdocstheme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None

2
test-requirements.txt
View File

@ -9,7 +9,7 @@ hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0
beautifulsoup4 # MIT
Jinja2>=2.8 # BSD License (3 clause)
openstack-doc-tools>=1.4.0 # Apache-2.0
sphinx>=1.5.1,<1.6 # BSD
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
doc8 # Apache-2.0
requests>=2.14.2 # Apache-2.0