Merge "Switch to newer openstackdocstheme and reno versions"

api-ref/source/conf.py

@@ -41,10 +41,12 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-repository_name = 'openstack/stx-metal'
 project = u'StarlingX Metal'
-bug_project = 'starlingx'
-bug_tag = 'stx.metal'
+
+# openstackdocstheme options
+openstackdocs_repo_name = 'starlingx/metal'
+openstackdocs_use_storyboard = True
+openstackdocs_auto_name = False
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
@@ -55,7 +57,7 @@ add_module_names = False
 show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass

doc/requirements.txt

@@ -1,8 +1,8 @@
-sphinx>=1.6.2
-openstackdocstheme>=1.26.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
 
 # Release Notes
-reno>=0.1.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
 
 # API Reference Guide
 os-api-ref>=1.4.0 # Apache-2.0

doc/source/conf.py

@@ -24,11 +24,6 @@ project = u'StarlingX Metal'
 copyright = u'2018, StarlingX'
 author = u'StarlingX'
 
-# The short X.Y version
-version = u''
-# The full version, including alpha/beta/rc tags
-release = u'0.1'
-
 
 # -- General configuration ---------------------------------------------------
 
@@ -55,8 +50,10 @@ source_suffix = '.rst'
 # The master toctree document.
 master_doc = 'index'
 
-bug_project = 'starlingx'
-bug_tag = 'stx.metal'
+# openstackdocstheme options
+openstackdocs_repo_name = 'starlingx/metal'
+openstackdocs_use_storyboard = True
+openstackdocs_auto_name = False
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -71,7 +68,7 @@ language = None
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 
 # -- Options for HTML output -------------------------------------------------

releasenotes/source/conf.py

@@ -31,8 +31,10 @@ extensions = [
     'reno.sphinxext',
 ]
 
-bug_project = 'starlingx'
-bug_tag = 'stx.metal'
+# openstackdocstheme options
+openstackdocs_repo_name = 'starlingx/metal'
+openstackdocs_use_storyboard = True
+openstackdocs_auto_name = False
 
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']
@@ -83,7 +85,7 @@ exclude_patterns = []
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -132,10 +134,6 @@ html_theme = 'starlingxdocs'
 # directly to the root of the documentation.
 # html_extra_path = []
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
 # html_use_smartypants = True