diff options
| author | Jenkins <jenkins@review.openstack.org> | 2017-07-07 21:14:52 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2017-07-07 21:14:52 +0000 |
| commit | 935298013fc8cf370f423990b11608d493c80db3 (patch) | |
| tree | ac4d15e29ef409d09ec49a8e760d9f87112ff44f | |
| parent | 00e3db3adc093f000ccbc570ece379fd5bd6e9d4 (diff) | |
| parent | 7790167f6f9f128a973059e55a5552b7b172cd02 (diff) | |
| download | python-neutronclient-935298013fc8cf370f423990b11608d493c80db3.tar.gz | |
Merge "doc: use new config options of openstackdocstheme"
| -rw-r--r-- | doc/source/conf.py | 41 | ||||
| -rw-r--r-- | releasenotes/source/conf.py | 107 |
2 files changed, 16 insertions, 132 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 0e4f725..4043a82 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,21 +1,21 @@ # -*- coding: utf-8 -*- # -import os - -import openstackdocstheme - - -project = 'python-neutronclient' - # -- General configuration --------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'reno.sphinxext', + 'openstackdocstheme', ] +# openstackdocstheme options +repository_name = 'openstack/python-neutronclient' +bug_project = 'python-neutronclient' +bug_tag = 'doc' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -44,30 +44,5 @@ pygments_style = 'sphinx' # Sphinx are currently 'default' and 'sphinxdoc'. html_theme = 'openstackdocs' -html_theme_path = [openstackdocstheme.get_html_theme_path()] - -gitsha = os.popen("/usr/bin/git rev-parse HEAD").read() -giturl = ('https://git.openstack.org/cgit/openstack/%s/tree/doc/source' - % 'python-neutronclient') -html_context = { - 'gitsha': gitsha, - 'giturl': giturl, - 'bug_project': 'python-neutronclient', - 'bug_tag': 'doc', -} -html_last_updated_fmt = os.popen("git log --pretty=format:'%ad' " - "--date=format:'%Y-%m-%d %H:%M' -n1").read() - # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project - - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, -# documentclass [howto/manual]). -latex_documents = [ - ('index', - '%s.tex' % project, - u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), -] +htmlhelp_basename = 'neutronclientdoc' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index f635d2e..b955f99 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -29,10 +29,6 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. # sys.path.insert(0, os.path.abspath('.')) -import os - -import openstackdocstheme - # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -43,8 +39,15 @@ import openstackdocstheme # ones. extensions = [ 'reno.sphinxext', + 'openstackdocstheme', ] +# openstackdocstheme options +repository_name = 'openstack/python-neutronclient' +bug_project = 'python-neutronclient' +bug_tag = 'doc' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -123,7 +126,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 = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". @@ -195,99 +198,5 @@ html_static_path = ['_static'] # Output file base name for HTML help builder. htmlhelp_basename = 'NeutronReleaseNotesdoc' -gitsha = os.popen("/usr/bin/git rev-parse HEAD").read() -giturl = ('https://git.openstack.org/cgit/openstack/%s/tree/doc/source' - % 'python-neutronclient') -html_context = { - 'gitsha': gitsha, - 'giturl': giturl, - 'bug_project': 'python-neutronclient', - 'bug_tag': 'doc', -} -html_last_updated_fmt = os.popen("git log --pretty=format:'%ad' " - "--date=format:'%Y-%m-%d %H:%M' -n1").read() - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # 'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'NeutronClientReleaseNotes.tex', - u'Neutron Client Release Notes Documentation', - u'Neutron Developers', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'neutronclientreleasenotes', - u'Neutron Client Release Notes Documentation', - [u'Neutron Developers'], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'NeutronClientReleaseNotes', - u'Neutron Client Release Notes Documentation', - u'Neutron Developers', 'NeutronClientReleaseNotes', - 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - # -- Options for Internationalization output ------------------------------ locale_dirs = ['locale/'] |
