diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index bc17311df..67aad643e 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -50,10 +50,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -repository_name = 'openstack/stx-distcloud' project = u'StarlingX Distributed Cloud' -bug_project = 'starlingx' -bug_tag = 'stx.distcloud' + +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/distcloud' +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::). @@ -64,7 +66,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 diff --git a/doc/requirements.txt b/doc/requirements.txt index d197d454a..5f5e43775 100644 --- a/doc/requirements.txt +++ b/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 documentation -reno>=0.1.1 # Apache2 +reno>=3.1.0 # Apache-2.0 # Api Ref documentation os-api-ref>=1.4.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index c7af2a1a6..f866d7e17 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -25,12 +25,6 @@ project = u'StarlingX Distributed Cloud' 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 --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. @@ -56,8 +50,10 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' -bug_project = '1027' -bug_tag = 'stx.bug' +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/distcloud' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -72,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 ------------------------------------------------- diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index b3de55acb..181dc0063 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -44,8 +44,10 @@ extensions = [ # General information about the project. project = u'StarlingX Distributed Cloud' -bug_project = '1027' -bug_tag = 'stx.bug' +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/distcloud' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -93,7 +95,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 = [] @@ -142,10 +144,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