diff --git a/doc/source/conf.py b/doc/source/conf.py index 594d7d0..1a54d6c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -13,8 +13,6 @@ import os import sys -from monascaclient.version import version_info - sys.path = [ os.path.abspath('../..'), os.path.abspath('../../bin') @@ -23,7 +21,7 @@ sys.path = [ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.6' +needs_sphinx = '2.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -37,14 +35,12 @@ extensions = [ ] # geeneral information about project -repository_name = u'openstack/python-monascaclient' +openstackdocs_repo_name = u'openstack/python-monascaclient' project = u'Monasca Client Dev Docs' -version = version_info.canonical_version_string() -release = version_info.version_string_with_vcs() -bug_project = u'880' -bug_tag = u'' +openstackdocs_use_storyboard = True copyright = u'2014-present, OpenStack Foundation' author = u'OpenStack Foundation' +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -80,7 +76,7 @@ add_module_names = True show_authors = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output ---------------------------------------------- @@ -88,10 +84,6 @@ pygments_style = 'sphinx' # a list of builtin themes. html_theme = 'openstackdocs' -# 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 false, no index is generated. html_use_index = True @@ -130,6 +122,3 @@ texinfo_documents = [ author, 'python-monascaclient', 'Rest-API to collect logs from your cloud.', 'Miscellaneous'), ] - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://doc.python.org/': None} diff --git a/lower-constraints.txt b/lower-constraints.txt index 5331b57..c798d4e 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -34,7 +34,7 @@ msgpack-python==0.4.0 munch==2.1.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.18.1 +openstackdocstheme==2.2.1 openstacksdk==0.11.2 os-client-config==1.28.0 os-service-types==1.2.0 @@ -54,7 +54,7 @@ python-mimeparse==1.6.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 +reno==3.1.0 requests==2.14.2 requestsexceptions==1.2.0 restructuredtext-lint==1.1.1 @@ -62,7 +62,7 @@ simplejson==3.5.1 six==1.10.0 smmap==0.9.0 snowballstemmer==1.2.1 -Sphinx==1.6.5 +Sphinx==2.0.0 sphinxcontrib-websupport==1.0.1 stestr==1.0.0 stevedore==1.20.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index ecf849b..7933898 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -36,20 +36,20 @@ source_encoding = 'utf-8' master_doc = 'index' # General information about the project. -repository_name = u'openstack/python-monascaclient' +openstackdocs_repo_name = u'openstack/python-monascaclient' project = u'Monasca Client ReleaseNotes Docs' # Release notes do not need a version number in the title, they # cover multiple releases. version = '' release = '' -bug_project = u'880' -bug_tag = u'' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False copyright = u'2014-present, OpenStack Foundation' author = u'OpenStack Foundation' # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output ---------------------------------------------- @@ -57,10 +57,6 @@ pygments_style = 'sphinx' # a list of builtin themes. html_theme = 'openstackdocs' -# 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' - # Output file base name for HTML help builder. htmlhelp_basename = 'MonascaClientReleaseNotesDoc' diff --git a/test-requirements.txt b/test-requirements.txt index 698ee80..e4cd8aa 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -13,6 +13,6 @@ testtools>=2.2.0 # MIT # documentation doc8>=0.6.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.5 # BSD -reno>=2.5.0 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +reno>=3.1.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0