Doc migration fixes
This brings the docs inline with the rest of the OpenStack-Ansible repositories. Change-Id: I310fefd254dff8f1f9103819539ea1ac82e464c0
This commit is contained in:
parent
f422da8599
commit
72afbcfc96
@ -25,7 +25,6 @@ import os
|
|||||||
import sys
|
import sys
|
||||||
|
|
||||||
|
|
||||||
import openstackdocstheme
|
|
||||||
import pbr.version
|
import pbr.version
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
@ -49,6 +48,7 @@ sys.setrecursionlimit(4000)
|
|||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
|
'openstackdocstheme',
|
||||||
'metadata-docs',
|
'metadata-docs',
|
||||||
'metadata-docs-rhel7',
|
'metadata-docs-rhel7',
|
||||||
]
|
]
|
||||||
@ -72,8 +72,8 @@ copyright = '2014-2016, OpenStack-Ansible Contributors'
|
|||||||
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
|
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
|
||||||
project = 'OpenStack-Ansible'
|
project = 'OpenStack-Ansible'
|
||||||
role_name = 'security'
|
role_name = 'security'
|
||||||
target_name = 'openstack-ansible-' + role_name
|
target_name = 'ansible-hardening'
|
||||||
title = 'OpenStack-Ansible Documentation: ' + role_name + 'role'
|
title = 'ansible-hardening Documentation:'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
@ -86,22 +86,10 @@ release = version_info.version_string_with_vcs()
|
|||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = version_info.canonical_version_string()
|
version = version_info.canonical_version_string()
|
||||||
|
|
||||||
# A few variables have to be set for the log-a-bug feature.
|
# openstackdocstheme options
|
||||||
# giturl: The location of conf.py on Git. Must be set manually.
|
repository_name = 'openstack/' + target_name
|
||||||
# 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 = ("https://git.openstack.org/cgit/openstack/{0}"
|
|
||||||
"/tree/doc/source").format(target_name)
|
|
||||||
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
|
|
||||||
gitsha = os.popen(git_cmd).read().strip('\n')
|
|
||||||
bug_title = "Documentation bug"
|
|
||||||
bug_project = project.lower()
|
bug_project = project.lower()
|
||||||
html_context = {"gitsha": gitsha, "giturl": giturl,
|
bug_tag = ''
|
||||||
"bug_tag": "docs", "bug_title": bug_title,
|
|
||||||
"bug_project": bug_project}
|
|
||||||
|
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
@ -162,7 +150,7 @@ html_theme_options = {
|
|||||||
}
|
}
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
html_theme_path = [openstackdocstheme.get_html_theme_path()]
|
# html_theme_path = []
|
||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> documentation".
|
# "<project> v<release> documentation".
|
||||||
|
@ -38,7 +38,7 @@ import pbr.version
|
|||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
# ones.
|
# ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'oslosphinx',
|
'openstackdocstheme',
|
||||||
'reno.sphinxext',
|
'reno.sphinxext',
|
||||||
]
|
]
|
||||||
|
|
||||||
@ -57,12 +57,12 @@ master_doc = 'index'
|
|||||||
# General information about the project.
|
# General information about the project.
|
||||||
author = 'OpenStack-Ansible Contributors'
|
author = 'OpenStack-Ansible Contributors'
|
||||||
category = 'Miscellaneous'
|
category = 'Miscellaneous'
|
||||||
copyright = '2014-2016, OpenStack-Ansible Contributors'
|
copyright = '2014-2017, OpenStack-Ansible Contributors'
|
||||||
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
|
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
|
||||||
project = 'OpenStack-Ansible'
|
project = 'OpenStack-Ansible'
|
||||||
role_name = 'security'
|
role_name = 'security'
|
||||||
target_name = 'openstack-ansible-' + role_name
|
target_name = 'ansible-hardening'
|
||||||
title = 'OpenStack-Ansible Release Notes: ' + role_name + 'role'
|
title = 'ansible-hardening Documentation:'
|
||||||
|
|
||||||
# The link to the browsable source code (for the left hand menu)
|
# The link to the browsable source code (for the left hand menu)
|
||||||
oslosphinx_cgit_link = 'https://git.openstack.org/cgit/openstack/' + target_name
|
oslosphinx_cgit_link = 'https://git.openstack.org/cgit/openstack/' + target_name
|
||||||
@ -78,6 +78,11 @@ release = version_info.version_string_with_vcs()
|
|||||||
# The short X.Y version.
|
# The short X.Y version.
|
||||||
version = version_info.canonical_version_string()
|
version = version_info.canonical_version_string()
|
||||||
|
|
||||||
|
# openstackdocstheme options
|
||||||
|
repository_name = 'openstack/' + target_name
|
||||||
|
bug_project = project.lower()
|
||||||
|
bug_tag = ''
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
# language = None
|
# language = None
|
||||||
|
@ -10,7 +10,6 @@ ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD
|
|||||||
|
|
||||||
# this is required for the docs build jobs
|
# this is required for the docs build jobs
|
||||||
sphinx!=1.6.1,>=1.5.1 # BSD
|
sphinx!=1.6.1,>=1.5.1 # BSD
|
||||||
oslosphinx>=4.7.0 # Apache-2.0
|
|
||||||
openstackdocstheme>=1.5.0 # Apache-2.0
|
openstackdocstheme>=1.5.0 # Apache-2.0
|
||||||
doc8 # Apache-2.0
|
doc8 # Apache-2.0
|
||||||
reno>=1.8.0 # Apache-2.0
|
reno>=1.8.0 # Apache-2.0
|
||||||
|
Loading…
x
Reference in New Issue
Block a user