diff --git a/security-guide/source/conf.py b/security-guide/source/conf.py index 0bf900b6..e89a66d2 100644 --- a/security-guide/source/conf.py +++ b/security-guide/source/conf.py @@ -22,8 +22,6 @@ import os -import openstackdocstheme - # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -32,7 +30,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'] @@ -47,9 +45,10 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name = 'openstack/security-doc' project = u'Security Guide' bug_tag = u'sec-guide' -copyright = u'2015, 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 @@ -60,19 +59,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. -# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2 -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/security-doc/tree/security-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, - "bug_project": "ossp-security-documentation"} - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -124,7 +110,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/security-threat-analysis/source/conf.py b/security-threat-analysis/source/conf.py index 93e74731..58948a45 100644 --- a/security-threat-analysis/source/conf.py +++ b/security-threat-analysis/source/conf.py @@ -22,8 +22,6 @@ import os -import openstackdocstheme - # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. @@ -32,7 +30,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'] @@ -47,9 +45,11 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. +repository_name = 'openstack/security-doc' project = u'Security Threat Analysis' +bug_project = 'ossp-security-documentation' bug_tag = u'threat-analysis' -copyright = u'2016, OpenStack contributors' +copyright = u'2016-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 @@ -60,18 +60,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. -# pwd: source tree - this is needed only for openstackdocstheme <= 1.2.2 -# These variables are passed to the logabug code via html_context. -giturl = u'https://git.openstack.org/cgit/openstack/security-doc/tree/security-threat-analysis/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 @@ -123,7 +111,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/test-requirements.txt b/test-requirements.txt index 725bac78..f60d10a7 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,9 +3,9 @@ # process, which may cause wedges in the gate later. doc8 # Apache-2.0 -openstack-doc-tools>=1.1.0 # Apache-2.0 -sphinx>=1.5.1,<1.6 # BSD -openstackdocstheme>=1.5.0 # Apache-2.0 +openstack-doc-tools>=1.4.0 # Apache-2.0 +sphinx>=1.6.2 # BSD +openstackdocstheme>=1.11.0 # Apache-2.0 # For translations -Babel>=2.3.4 # BSD +Babel>=2.3.4,!=2.4.0 # BSD