diff --git a/bindep.txt b/bindep.txt index 86a144a1df..4778ba7595 100644 --- a/bindep.txt +++ b/bindep.txt @@ -19,3 +19,4 @@ texlive-latex-base [platform:dpkg] texlive-latex-extra [platform:dpkg] texlive-xetex [platform:dpkg] texlive-fonts-recommended [platform:dpkg] +latexmk [platform:dpkg] diff --git a/doc/admin-guide/source/conf.py b/doc/admin-guide/source/conf.py index 62d1b5408b..104af9330e 100644 --- a/doc/admin-guide/source/conf.py +++ b/doc/admin-guide/source/conf.py @@ -24,8 +24,6 @@ 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. @@ -39,7 +37,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'] @@ -54,6 +52,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Administrator Guide' bug_tag = u'admin-guide' copyright = u'2015-2017, OpenStack contributors' @@ -67,17 +66,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/admin-guide/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -130,7 +118,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/arch-design-to-archive/source/conf.py b/doc/arch-design-to-archive/source/conf.py index 5ccc3bf232..9e18160a6e 100644 --- a/doc/arch-design-to-archive/source/conf.py +++ b/doc/arch-design-to-archive/source/conf.py @@ -23,8 +23,6 @@ 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. @@ -38,7 +36,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 = ['sphinx.ext.todo'] +extensions = ['openstackdocstheme'] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -53,9 +51,10 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Architecture Design Guide' bug_tag = u'arch-design-to-archive' -copyright = u'2015-2016, OpenStack contributors' +copyright = u'2015-2017, OpenStack contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -66,17 +65,6 @@ version = '0.9' # The full version, including alpha/beta/rc tags. release = '0.9' -# 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'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/arch-design-rst/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -128,7 +116,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/arch-design/source/conf.py b/doc/arch-design/source/conf.py index 255f1848cf..7c4d2e49c6 100644 --- a/doc/arch-design/source/conf.py +++ b/doc/arch-design/source/conf.py @@ -39,7 +39,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'] @@ -54,6 +54,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Architecture Design Guide' bug_tag = u'arch-design' copyright = u'2015-2017, OpenStack contributors' @@ -67,17 +68,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/arch-design/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -129,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/cli-reference/source/conf.py b/doc/cli-reference/source/conf.py index 78160185eb..286c3f378f 100644 --- a/doc/cli-reference/source/conf.py +++ b/doc/cli-reference/source/conf.py @@ -29,8 +29,6 @@ sys.path.append(os.path.dirname(__file__)) # "RuntimeError: maximum recursion depth exceeded in cmp" issue. sys.setrecursionlimit(4000) -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. @@ -44,7 +42,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'] @@ -59,6 +57,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Command-Line Interface Reference' bug_tag = u'cli-reference' copyright = u'2015-2017, OpenStack contributors' @@ -72,17 +71,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/cli-reference/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -134,7 +122,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/common/source/conf.py b/doc/common/source/conf.py index 004660291f..58cd57ad53 100644 --- a/doc/common/source/conf.py +++ b/doc/common/source/conf.py @@ -24,8 +24,6 @@ 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. @@ -39,7 +37,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'] @@ -54,6 +52,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Common documents' bug_tag = u'common' @@ -68,17 +67,6 @@ version = '1.0.0' # The full version, including alpha/beta/rc tags. release = '1.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/common/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None diff --git a/doc/config-reference/source/block-storage/drivers/dell-emc-unity-driver.rst b/doc/config-reference/source/block-storage/drivers/dell-emc-unity-driver.rst index b6d4be5583..7c68458fdc 100644 --- a/doc/config-reference/source/block-storage/drivers/dell-emc-unity-driver.rst +++ b/doc/config-reference/source/block-storage/drivers/dell-emc-unity-driver.rst @@ -278,9 +278,11 @@ connect this snapshot to the Block Storage host for volume backup. Troubleshooting ~~~~~~~~~~~~~~~ -To troubleshoot a failure in OpenStack deployment, the best way is to enable -verbose and debug log, at the same time, leverage the build-in [request_id]_ to -track specific Block Storage command logs. +To troubleshoot a failure in OpenStack deployment, the best way is to +enable verbose and debug log, at the same time, leverage the build-in +`Return request ID to caller +`_ +to track specific Block Storage command logs. #. Enable verbose log, set following in ``/etc/cinder/cinder.conf`` and restart @@ -335,8 +337,3 @@ track specific Block Storage command logs. # grep "req-3a459e0e-871a-49f9-9796-b63cc48b5015" cinder-volume.log - - - -.. [request_id] `Return request ID to caller - `_ diff --git a/doc/config-reference/source/conf.py b/doc/config-reference/source/conf.py index 53a513438e..f0be1c1a19 100644 --- a/doc/config-reference/source/conf.py +++ b/doc/config-reference/source/conf.py @@ -25,8 +25,6 @@ import sys sys.path.append(os.path.dirname(__file__)) -import openstackdocstheme - # Avoid unactionable warnings import requestsexceptions requestsexceptions.squelch_warnings(requestsexceptions.InsecureRequestWarning) @@ -44,7 +42,9 @@ requestsexceptions.squelch_warnings(requestsexceptions.InsecureRequestWarning) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['ext.remote', 'sphinxmark'] +extensions = ['ext.remote', + 'sphinxmark', + 'openstackdocstheme'] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -59,6 +59,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Configuration Reference' bug_tag = u'config-reference' copyright = u'2015-2017, OpenStack contributors' @@ -72,17 +73,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/config-reference/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -134,7 +124,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/contributor-guide/source/api-guides.rst b/doc/contributor-guide/source/api-guides.rst index f75138ac78..7da5077592 100644 --- a/doc/contributor-guide/source/api-guides.rst +++ b/doc/contributor-guide/source/api-guides.rst @@ -93,19 +93,25 @@ The basic steps are: include the html theme, openstackdocstheme, use the os-api-ref Sphinx extension, and also point the bug reporting link to your project's repo:: - import openstackdocstheme - extensions = [ 'os_api_ref', + 'openstackdocstheme' ] + # The prefix and repo name like + repository_name = 'openstack/glance' + # Set Launchpad bug tag, default is empty + bug_tag = '' + # The launchpad project name like + bug_project = 'glance' html_theme = 'openstackdocs' - html_theme_path = [openstackdocstheme.get_html_theme_path()] html_theme_options = { "sidebar_mode": "toc", } - html_context = {'bug_project': 'nova', 'bug_tag': 'api-ref'} + + # Must set this variable to include year, month, day, hours, and minutes. + html_last_updated_fmt = '%Y-%m-%d %H:%M' #. Update the ``test-requirements.txt`` file for the project with a line for the ``os-api-ref`` Sphinx extension:: diff --git a/doc/contributor-guide/source/conf.py b/doc/contributor-guide/source/conf.py index 6f39b23f0c..f6ffe67d36 100644 --- a/doc/contributor-guide/source/conf.py +++ b/doc/contributor-guide/source/conf.py @@ -24,8 +24,6 @@ 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. @@ -39,7 +37,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. @@ -55,6 +53,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Contributor Guide' bug_tag = u'contributor-guide' @@ -70,17 +69,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/contributor-guide/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -136,7 +124,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/ha-guide-draft/source/conf.py b/doc/ha-guide-draft/source/conf.py index 6500ece076..c27d9e4dfc 100644 --- a/doc/ha-guide-draft/source/conf.py +++ b/doc/ha-guide-draft/source/conf.py @@ -23,8 +23,6 @@ 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. @@ -38,7 +36,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'] @@ -53,6 +51,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'High Availability Guide Draft' bug_tag = u'ha-guide-draft' copyright = u'2017, OpenStack contributors' @@ -66,17 +65,6 @@ version = '0.0.1' # The full version, including alpha/beta/rc tags. release = '0.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'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/ha-guide-draft/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -129,7 +117,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/ha-guide/source/conf.py b/doc/ha-guide/source/conf.py index 27d9297887..def37f7043 100644 --- a/doc/ha-guide/source/conf.py +++ b/doc/ha-guide/source/conf.py @@ -38,7 +38,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'] @@ -53,6 +53,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'High Availability Guide' bug_tag = u'ha-guide' copyright = u'2015-2017, OpenStack contributors' @@ -66,17 +67,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/ha-guide/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -130,7 +120,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/image-guide/source/conf.py b/doc/image-guide/source/conf.py index cfb60ecc18..43082c7ebe 100644 --- a/doc/image-guide/source/conf.py +++ b/doc/image-guide/source/conf.py @@ -38,7 +38,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'] @@ -53,6 +53,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Virtual Machine Image Guide' bug_tag = u'image-guide' copyright = u'2015-2017, OpenStack contributors' @@ -66,17 +67,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/image-guide/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -129,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/install-guide/source/conf.py b/doc/install-guide/source/conf.py index 049614d947..d277f4d934 100644 --- a/doc/install-guide/source/conf.py +++ b/doc/install-guide/source/conf.py @@ -23,7 +23,6 @@ import os # import sys - import openstackdocstheme # If extensions (or modules to document with autodoc) are in another directory, @@ -39,7 +38,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 = ['sphinxmark'] +extensions = ['sphinxmark', 'openstackdocstheme'] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -54,6 +53,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Installation Guide' bug_tag = u'install-guide' copyright = u'2015-2017, OpenStack contributors' @@ -67,17 +67,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -141,7 +130,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/networking-guide/source/conf.py b/doc/networking-guide/source/conf.py index 82c865d6b3..705959ef19 100644 --- a/doc/networking-guide/source/conf.py +++ b/doc/networking-guide/source/conf.py @@ -38,7 +38,9 @@ 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 = ['sphinx.ext.todo', 'sphinxmark'] +extensions = ['sphinx.ext.todo', + 'sphinxmark', + 'openstackdocstheme'] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -53,6 +55,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Networking Guide' bug_tag = u'networking-guide' copyright = u'2015-2017, OpenStack contributors' @@ -66,17 +69,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/networking-guide/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -128,7 +120,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/ops-guide/source/conf.py b/doc/ops-guide/source/conf.py index 63534cf3dc..3adb3c3b7f 100644 --- a/doc/ops-guide/source/conf.py +++ b/doc/ops-guide/source/conf.py @@ -38,7 +38,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'] @@ -53,6 +53,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'Operations Guide' bug_tag = u'ops-guide' copyright = u'2016-2017, OpenStack contributors' @@ -66,17 +67,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/ops-guide/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -130,7 +120,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 = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/user-guide/source/conf.py b/doc/user-guide/source/conf.py index ae6bf94050..cea6655d3b 100644 --- a/doc/user-guide/source/conf.py +++ b/doc/user-guide/source/conf.py @@ -38,7 +38,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'] @@ -53,6 +53,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name="openstack/openstack-manuals" project = u'End User Guide' bug_tag = u'user-guide' @@ -67,17 +68,6 @@ version = '15.0' # The full version, including alpha/beta/rc tags. release = '15.0.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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/user-guide/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} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -129,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 = [openstackdocstheme.get_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 2f6a8d9f3e..22c5f7645f 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -23,8 +23,6 @@ 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,6 +38,7 @@ import openstackdocstheme # ones. extensions = [ 'reno.sphinxext', + 'openstackdocstheme' ] # Add any paths that contain templates here, relative to this directory. @@ -56,6 +55,7 @@ master_doc = 'index' # General information about the project. project = u'OpenStack Documentation Team Release Notes' +repository_name="openstack/openstack-manuals" bug_tag = u'releasenotes' copyright = u'2016, OpenStack contributors' @@ -68,16 +68,6 @@ 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. -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/releasenotes/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} # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -129,9 +119,6 @@ html_theme = 'openstackdocs' # documentation. # html_theme_options = {} -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None diff --git a/test-requirements.txt b/test-requirements.txt index de35cd5cef..db24cc0cea 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,7 +9,7 @@ hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0 beautifulsoup4 # MIT Jinja2>=2.8 # BSD License (3 clause) openstack-doc-tools>=1.4.0 # Apache-2.0 -sphinx>=1.5.1,<1.6 # BSD +sphinx>=1.6.2 # BSD openstackdocstheme>=1.11.0 # Apache-2.0 doc8 # Apache-2.0 requests>=2.14.2 # Apache-2.0