Update openstackdocstheme
Update requirements, simplifiy conf.py with new theme requirement. Change-Id: I5e49078171d92892470bc438a377f780a817a5fd
This commit is contained in:
Andreas Jaeger
parent
42ed58b00e
commit
b13184b995
|
|
@ -20,7 +20,6 @@
|
|||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import openstackdocstheme
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
|
|
@ -37,7 +36,7 @@ import subprocess
|
|||
# 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']
|
||||
|
|
@ -52,9 +51,11 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
repository_name = 'openstack/api-site'
|
||||
project = u'Openstack-API-Documentation'
|
||||
bug_project = 'openstack-api-site'
|
||||
bug_tag = u'api-site'
|
||||
copyright = u'2016, OpenStack contributors'
|
||||
copyright = u'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
|
||||
|
|
@ -65,22 +66,6 @@ version = '0.1'
|
|||
# The full version, including alpha/beta/rc tags.
|
||||
release = '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. Extracted from git log.
|
||||
# bug_tag: Tag for categorizing the bug. Must be set manually.
|
||||
# bug_project: Project to file bugs against.
|
||||
# These variables are passed to the logabug code via html_context.
|
||||
giturl = u'https://git.openstack.org/cgit/openstack/api-site/tree/api-quick-start/source'
|
||||
git_cmd = ["/usr/bin/git", "log", "-1"]
|
||||
last_commit = subprocess.Popen(git_cmd, stdout=subprocess.PIPE)
|
||||
first_line_cmd = ["head", "-n1"]
|
||||
gitsha = subprocess.Popen(first_line_cmd, stdin=last_commit.stdout,
|
||||
stdout=subprocess.PIPE).communicate()[0].split()[-1].strip()
|
||||
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
|
||||
"giturl": giturl,
|
||||
"bug_project": "openstack-api-site"}
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
# language = None
|
||||
|
|
@ -140,7 +125,7 @@ html_theme_options = {"sidebar_dropdown": "api_ref",
|
|||
"sidebar_mode": "toc"}
|
||||
|
||||
# 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,7 +20,6 @@
|
|||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import openstackdocstheme
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
|
|
@ -42,7 +41,8 @@ extensions = [
|
|||
'sphinx.ext.ifconfig',
|
||||
'sphinxcontrib.nwdiag',
|
||||
'sphinx.ext.graphviz',
|
||||
'sphinx.ext.todo'
|
||||
'sphinx.ext.todo',
|
||||
'openstackdocstheme'
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
|
|
@ -58,9 +58,11 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
repository_name = 'openstack/api-site'
|
||||
project = u'FirstApp'
|
||||
bug_project = 'openstack-api-site'
|
||||
bug_tag = u'firstapp'
|
||||
copyright = u'2015, OpenStack contributors'
|
||||
copyright = u'2015-2017, OpenStack contributors'
|
||||
|
||||
# The version info for the project you are documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
|
|
@ -71,22 +73,6 @@ version = '0.1'
|
|||
# The full version, including alpha/beta/rc tags.
|
||||
release = '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.
|
||||
# bug_project: Project to file bugs against.
|
||||
# These variables are passed to the logabug code via html_context.
|
||||
giturl = u'https://git.openstack.org/cgit/openstack/api-site/tree/firstapp/source'
|
||||
git_cmd = ["/usr/bin/git", "log", "-1"]
|
||||
last_commit = subprocess.Popen(git_cmd, stdout=subprocess.PIPE)
|
||||
first_line_cmd = ["head", "-n1"]
|
||||
gitsha = subprocess.Popen(first_line_cmd, stdin=last_commit.stdout,
|
||||
stdout=subprocess.PIPE).communicate()[0].split()[-1].strip()
|
||||
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
|
||||
"giturl": giturl,
|
||||
"bug_project": "openstack-api-site"}
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
# language = None
|
||||
|
|
@ -138,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".
|
||||
|
|
|
|||
|
|
@ -1,17 +1,18 @@
|
|||
# The order of packages is significant, because pip processes them in the order
|
||||
# of appearance. Changing the order has an impact on the overall integration
|
||||
# process, which may cause wedges in the gate later.
|
||||
pbr>=1.8 # Apache-2.0
|
||||
|
||||
openstack-doc-tools>=1.1.0 # Apache-2.0
|
||||
pbr>=2.0.0,!=2.1.0 # Apache-2.0
|
||||
|
||||
openstack-doc-tools>=1.4.0 # Apache-2.0
|
||||
doc8 # Apache-2.0
|
||||
Pygments
|
||||
|
||||
sphinx>=1.5.1,<1.6 # BSD
|
||||
sphinx>=1.6.2 # BSD
|
||||
|
||||
openstackdocstheme>=1.5.0 # Apache-2.0
|
||||
openstackdocstheme>=1.11.0 # Apache-2.0
|
||||
nwdiag
|
||||
sphinxcontrib-nwdiag
|
||||
|
||||
# For translations
|
||||
Babel>=2.3.4 # BSD
|
||||
Babel>=2.3.4,!=2.4.0 # BSD
|
||||
|
|
|
|||
Loading…
Reference in New Issue