openstack/python-heatclient
Code Issues Proposed changes

Merge "Switch from oslosphinx to openstackdocstheme"

Browse Source
This commit is contained in:
Jenkins
2017-07-12 15:09:22 +00:00
committed by Gerrit Code Review
parent 4722facf06 2663e8d75c
commit 5ed0bba696
2 changed files with 10 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/conf.py
View File

@@ -24,8 +24,6 @@
# serve to show the default. # serve to show the default.
import os import os
import subprocess
import warnings
# If extensions (or modules to document with autodoc) are in another directory, # 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 # add these directories to sys.path here. If the directory is relative to the
@@ -38,7 +36,7 @@ exec(open(os.path.join("ext", "gen_ref.py")).read())
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions # extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'oslosphinx'] extensions = ['sphinx.ext.autodoc', 'openstackdocstheme']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
if os.getenv('HUDSON_PUBLISH_DOCS'): if os.getenv('HUDSON_PUBLISH_DOCS'):
@@ -112,7 +110,7 @@ nitpicky = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# html_theme_path = ['.'] # html_theme_path = ['.']
# html_theme = '_theme' html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
@@ -147,15 +145,7 @@ html_theme_options = {
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y' html_last_updated_fmt = '%Y-%m-%d %H:%M'
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
"-n1"]
try:
html_last_updated_fmt = subprocess.Popen(
git_cmd, stdout=subprocess.PIPE).communicate()[0]
except Exception:
warnings.warn('Cannot get last updated time from git repository. '
'Not setting "html_last_updated_fmt".')
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
@@ -198,7 +188,6 @@ except Exception:
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'python-heatclientdoc' htmlhelp_basename = 'python-heatclientdoc'
# -- Options for LaTeX output ------------------------------------------------- # -- Options for LaTeX output -------------------------------------------------
latex_elements = { latex_elements = {
@@ -273,3 +262,8 @@ texinfo_documents = [
# How to display URL addresses: 'footnote', 'no', or 'inline'. # How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote' # texinfo_show_urls = 'footnote'
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/python-heatclient'
bug_project = 'python-heatclient'
bug_tag = ''

4
test-requirements.txt
View File

@@ -9,10 +9,10 @@ fixtures>=3.0.0 # Apache-2.0/BSD
requests-mock>=1.1 # Apache-2.0 requests-mock>=1.1 # Apache-2.0
mock>=2.0 # BSD mock>=2.0 # BSD
mox3!=0.19.0,>=0.7.0 # Apache-2.0 mox3!=0.19.0,>=0.7.0 # Apache-2.0
oslosphinx>=4.7.0 # Apache-2.0 openstackdocstheme>=1.11.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0
python-openstackclient!=3.10.0,>=3.3.0 # Apache-2.0 python-openstackclient!=3.10.0,>=3.3.0 # Apache-2.0
sphinx!=1.6.1,>=1.5.1 # BSD sphinx>=1.6.2 # BSD
tempest>=14.0.0 # Apache-2.0 tempest>=14.0.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD