diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 08ab7226..3bbb8001 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -25,23 +25,24 @@ # serve to show the default. import os -import subprocess import sys -import warnings - -import openstackdocstheme extensions = [ 'os_api_ref', + 'openstackdocstheme' ] html_theme = 'openstackdocs' -html_theme_path = [openstackdocstheme.get_html_theme_path()] html_theme_options = { "sidebar_mode": "toc", } -html_context = {'bug_project': 'murano', 'bug_tag': 'api-ref'} + +# openstackdocstheme options +repository_name = 'openstack/murano' +bug_project = 'murano' +bug_tag = 'api-ref' +html_last_updated_fmt = '%Y-%m-%d %H:%M' # 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 @@ -150,17 +151,6 @@ pygments_style = 'sphinx' # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -try: - html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') -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 # typographically correct entities. # html_use_smartypants = True diff --git a/doc/source/conf.py b/doc/source/conf.py index 56ecfadf..68ff9f66 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -35,10 +35,10 @@ sys.path.insert(0, os.path.abspath('./')) # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', - 'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain'] + 'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain',] if not on_rtd: - extensions.append('oslosphinx') + extensions.append('openstackdocstheme') # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -52,6 +52,13 @@ master_doc = 'index' # General information about the project. project = 'Murano' +# openstackdocstheme options +repository_name = 'openstack/murano' +bug_project = 'murano' +bug_tag = '' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -84,21 +91,10 @@ if not on_rtd: #TODO(efedorova): Change local theme to correspond with the theme on rtd pass -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -try: - html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') -except OSError: - warnings.warn('Cannot get last updated time from git repository. ' - 'Not setting "html_last_updated_fmt".') - - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". html_title = 'Murano' +html_theme = 'openstackdocs' # Custom sidebar templates, maps document names to template names. html_sidebars = { diff --git a/doc/source/first-app/source/conf.py b/doc/source/first-app/source/conf.py index e8676c89..25f6e18d 100644 --- a/doc/source/first-app/source/conf.py +++ b/doc/source/first-app/source/conf.py @@ -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,13 +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 = [ -# 'sphinx.ext.todo', -# 'sphinx.ext.ifconfig', -# 'sphinxcontrib.nwdiag', -# 'sphinx.ext.graphviz', -# 'sphinx.ext.todo' -#] +extensions = ['openstackdocstheme'] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -59,9 +52,13 @@ master_doc = 'index' # General information about the project. project = u'Murano-FirstApp' -bug_tag = u'murano-firstapp' copyright = u'2016, OpenStack contributors' +# openstackdocstheme options +repository_name = 'openstack/murano' +bug_project = 'murano' +bug_tag = u'murano-firstapp' + # The version info for the project you are documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -71,22 +68,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/murano/tree/doc/source/api-guide/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": "murano"} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -138,7 +119,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 # " v documentation". diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py index 6b7d385f..91e675b0 100644 --- a/install-guide/source/conf.py +++ b/install-guide/source/conf.py @@ -20,12 +20,9 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import os # import sys -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 # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -40,7 +37,7 @@ import openstackdocstheme # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. # TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder' -# extensions = +extensions = ['openstackdocstheme'] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -56,9 +53,14 @@ master_doc = 'index' # General information about the project. project = u'Installation Guide for Application Catalog Service' -bug_tag = u'install-guide' copyright = u'2016, OpenStack contributors' +# openstackdocstheme options +repository_name = 'openstack/murano' +bug_project = 'murano' +bug_tag = u'install-guide' + + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -68,19 +70,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. -# These variables are passed to the logabug code via html_context. -giturl = u'http://git.openstack.org/cgit/openstack/murano/tree/install-guide/source' # noqa -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": "murano"} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -132,7 +121,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 # " v documentation". diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index f86cbc64..14b1ae5e 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,7 +38,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -58,6 +58,12 @@ master_doc = 'index' project = u'Murano Release Notes' copyright = u'2015, Murano Developers' +# openstackdocstheme options +repository_name = 'openstack/murano' +bug_project = 'murano' +bug_tag = '' +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. @@ -112,7 +118,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'openstackdocs' # 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 @@ -141,7 +147,7 @@ html_theme = 'default' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/test-requirements.txt b/test-requirements.txt index d3f614d2..0547843c 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -24,9 +24,8 @@ PyMySQL>=0.7.6 # MIT License psycopg2>=2.5 # LGPL/ZPL # doc build requirements -oslosphinx>=4.7.0 # Apache-2.0 -sphinx!=1.6.1,>=1.5.1 # BSD +sphinx>=1.6.2 # BSD sphinxcontrib-httpdomain # BSD reno!=2.3.1,>=1.8.0 # Apache-2.0 -openstackdocstheme>=1.5.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 os-api-ref>=1.0.0 # Apache-2.0