diff --git a/doc/requirements.txt b/doc/requirements.txt index 3a7529d..f9f7a73 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,5 @@ -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 diff --git a/doc/source/conf.py b/doc/source/conf.py index b6aeaf0..66d6c20 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,11 +27,6 @@ project = u'StarlingX Distributed Cloud Client' 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 --------------------------------------------------- @@ -58,8 +53,11 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' -bug_project = '1027' -bug_tag = 'stx.bug' +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/distcloud-client' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -74,7 +72,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 2ccb62b..d154dfd 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -36,8 +36,10 @@ extensions = [ project = u'StarlingX Distributed Cloud Client' -bug_project = '1027' -bug_tag = 'stx.bug' +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/distcloud-client' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -85,7 +87,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 = [] @@ -134,10 +136,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