diff --git a/doc/requirements.txt b/doc/requirements.txt index 0a923db5..cb2601a9 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -6,9 +6,9 @@ # added in alphabetical order, however, some dependencies may need to # be installed in a specific order. # -openstackdocstheme>=1.18.1 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-apidoc>=0.2.0 # BSD # NOTE: The following are required as horizon.test.settings loads it. diff --git a/doc/source/conf.py b/doc/source/conf.py index d2808802..74120628 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,15 +22,11 @@ # All configuration values have a default; values that are commented out # serve to show the default. -from __future__ import print_function - import os import sys import django -from magnum_ui import version as magnumui_ver - BASE_DIR = os.path.dirname(os.path.abspath(__file__)) ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", "..")) @@ -81,15 +77,6 @@ master_doc = 'index' project = u'Magnum UI' copyright = u'2015, Cisco Systems, Inc.' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = magnumui_ver.version_info.version_string() -# The full version, including alpha/beta/rc tags. -release = magnumui_ver.version_info.release_string() - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -120,7 +107,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,9 +129,11 @@ apidoc_excluded_paths = [ html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/magnum-ui' -bug_project = 'magnum-ui' -bug_tag = '' +openstackdocs_repo_name = 'openstack/magnum-ui' +openstackdocs_pdf_link = True +openstackdocs_auto_name = False +openstackdocs_bug_project = 'magnum-ui' +openstackdocs_bug_tag = '' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -175,9 +164,6 @@ bug_tag = '' # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = [''] -# Must set this variable to include year, month, day, hours, and minutes. -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 diff --git a/lower-constraints.txt b/lower-constraints.txt index ca6c6bf2..a371870c 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -48,7 +48,6 @@ munch==2.2.0 netaddr==0.7.19 netifaces==0.10.6 nodeenv==0.9.4 -openstackdocstheme==1.18.1 openstacksdk==0.12.0 os-client-config==1.29.0 os-service-types==1.2.0 @@ -90,7 +89,6 @@ python-swiftclient==3.5.0 pytz==2018.3 PyYAML==3.12 rcssmin==1.0.6 -reno==2.5.0 requests==2.18.4 requestsexceptions==1.4.0 rfc3986==1.1.0 @@ -100,9 +98,6 @@ semantic-version==2.6.0 simplejson==3.13.2 six==1.11.0 snowballstemmer==1.2.1 -Sphinx==1.6.2 -sphinxcontrib-apidoc===0.2.0 -sphinxcontrib-websupport==1.0.1 stevedore==1.28.0 termcolor==1.1.0 testtools==2.3.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index b57fd352..7e47b547 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -91,7 +91,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 = [] @@ -107,9 +107,10 @@ pygments_style = 'sphinx' html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/magnum-ui' -bug_project = 'magnum-ui' -bug_tag = '' +openstackdocs_repo_name = 'openstack/magnum-ui' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'magnum-ui' +openstackdocs_bug_tag = '' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -145,9 +146,6 @@ bug_tag = '' # directly to the root of the documentation. # html_extra_path = [] -# Must set this variable to include year, month, day, hours, and minutes. -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