openinfra
/
refstack
Code Issues Proposed changes

Update Refstack docs for documentation migration 

This patch updates the Refstack documentation in support of the
OpenStack documentation migration[1]. Follow guide on [2]
Refstack documentation is displayed under Related Projects [3]

[1] https://specs.openstack.org/openstack/docs-specs/specs \
    /pike/os-manuals-migration.html
[2] https://docs.openstack.org/openstackdocstheme/latest/
[3] https://docs.openstack.org/openstack-projects.html

Change-Id: I6f3fbfcf8240da6aa1ee6f754205c5b615eec3d0
This commit is contained in:
Luz Cazares 2017-07-06 01:40:55 +00:00
parent 454a40b329
commit 9e4970217e
2 changed files with 7 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/conf.py
View File

@ -14,7 +14,6 @@
import sys
import os
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
@ -29,7 +28,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']
@ -56,19 +55,10 @@ 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.
# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2
# These variables are passed to the logabug code via html_context.
bug_tag = 'refstack'
giturl = u'https://git.openstack.org/cgit/openstack/refstack/tree/doc/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,
"bug_project": "refstack"}
# openstackdocstheme options
repository_name = 'openstack/refstack'
bug_project = '878'
bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -122,7 +112,6 @@ html_theme = 'openstackdocs'
# Add any paths that contain custom themes here, relative to this directory.
#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".

4
test-requirements.txt
View File

@ -3,7 +3,7 @@ pep8==1.5.7
pyflakes==0.8.1
flake8==2.2.4
docutils>=0.11 # OSI-Approved Open Source, Public Domain
sphinx>=1.5.1
sphinx>=1.6.2
httmock>=1.2.4
mock
oslotest>=1.2.0 # Apache-2.0
@ -12,4 +12,4 @@ testrepository>=0.0.18
testtools>=0.9.34
pep257>=0.5.0
PyMySQL>=0.6.2,!=0.6.4
openstackdocstheme>=1.5.0 # Apache-2.0
openstackdocstheme>=1.11.0 # Apache-2.0