openstack/openstack-manuals
Code Issues Proposed changes

Set giturl for openstackdocstheme 1.2.3

Browse Source 
Also whitelist conf.py by flake8.

Co-Authored-By: Bernd Bausch <berndbausch@gmail.com>
Change-Id: I9899fde4586a44aa4dd4e48402a3f25933bebc4a
This commit is contained in:
Andreas Jaeger 2015-10-06 08:22:05 +02:00
parent eadb588f5d
commit 8750c28ab1
7 changed files with 56 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/admin-guide-cloud/source/conf.py
View File

@ -68,14 +68,18 @@ version = '0.9'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.9' release = '0.9'
# We ask git for the SHA checksum # A few variables have to be set for the log-a-bug feature.
# The git SHA checksum is used by "log-a-bug" # 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.
# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2
# These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/admin-guide-cloud/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n') gitsha = os.popen(git_cmd).read().strip('\n')
# source tree
pwd = os.popen("pwd").read().strip('\n') pwd = os.popen("pwd").read().strip('\n')
# html_context allows us to pass arbitrary values into the html template html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag,
html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag} "giturl": giturl}
# 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.

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

@ -61,6 +61,7 @@ bug_tag = u'contributor-guide'
copyright = u'2015, OpenStack contributors' copyright = u'2015, OpenStack contributors'
# 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
# built documents. # built documents.
@ -70,14 +71,18 @@ version = '1.0.0'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '1.0.0' release = '1.0.0'
# We ask git for the SHA checksum # A few variables have to be set for the log-a-bug feature.
# The git SHA checksum is used by "log-a-bug" # 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.
# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2
# These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/contributor-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n') gitsha = os.popen(git_cmd).read().strip('\n')
# source tree
pwd = os.popen("pwd").read().strip('\n') pwd = os.popen("pwd").read().strip('\n')
# html_context allows us to pass arbitrary values into the html template html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag,
html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag} "giturl": giturl}
# 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.

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

@ -73,14 +73,18 @@ version = '0.1'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.1' release = '0.1'
# We ask git for the SHA checksum # A few variables have to be set for the log-a-bug feature.
# The git SHA checksum is used by "log-a-bug" # 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.
# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2
# These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n') gitsha = os.popen(git_cmd).read().strip('\n')
# source tree
pwd = os.popen("pwd").read().strip('\n') pwd = os.popen("pwd").read().strip('\n')
# html_context allows us to pass arbitrary values into the html template html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag,
html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag} "giturl": giturl}
# 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.

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

@ -66,14 +66,18 @@ version = '0.9'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.9' release = '0.9'
# We ask git for the SHA checksum # A few variables have to be set for the log-a-bug feature.
# The git SHA checksum is used by "log-a-bug" # 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.
# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2
# These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/networking-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n') gitsha = os.popen(git_cmd).read().strip('\n')
# source tree
pwd = os.popen("pwd").read().strip('\n') pwd = os.popen("pwd").read().strip('\n')
# html_context allows us to pass arbitrary values into the html template html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag,
html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag} "giturl": giturl}
# 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.

14
doc/user-guide-admin/source/conf.py
View File

@ -69,14 +69,18 @@ version = '1.0.0'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '1.0.0' release = '1.0.0'
# We ask git for the SHA checksum # A few variables have to be set for the log-a-bug feature.
# The git SHA checksum is used by "log-a-bug" # 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.
# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2
# These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guide-admin/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n') gitsha = os.popen(git_cmd).read().strip('\n')
# source tree
pwd = os.popen("pwd").read().strip('\n') pwd = os.popen("pwd").read().strip('\n')
# html_context allows us to pass arbitrary values into the html template html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag,
html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag} "giturl": giturl}
# 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.

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

@ -69,14 +69,18 @@ version = '1.0.0'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '1.0.0' release = '1.0.0'
# We ask git for the SHA checksum # A few variables have to be set for the log-a-bug feature.
# The git SHA checksum is used by "log-a-bug" # 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.
# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2
# These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n') gitsha = os.popen(git_cmd).read().strip('\n')
# source tree
pwd = os.popen("pwd").read().strip('\n') pwd = os.popen("pwd").read().strip('\n')
# html_context allows us to pass arbitrary values into the html template html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag,
html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag} "giturl": giturl}
# 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.

2
tox.ini
View File

@ -131,4 +131,4 @@ show-source = True
# E123, E125 skipped as they are invalid PEP-8. # E123, E125 skipped as they are invalid PEP-8.
ignore = E123,E125,H803 ignore = E123,E125,H803
builtins = _ builtins = _
exclude=.venv,.git,.tox,dist,*openstack/common*,*lib/python*,*egg,build,doc/common/samples exclude=.venv,.git,.tox,dist,*openstack/common*,*lib/python*,*egg,build,doc/common/samples,doc/*/source/conf.py