diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index b6d9ba0f2..34209bd5d 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -62,9 +62,10 @@ project = u'Networking API Reference' copyright = u'2010-present, OpenStack Foundation' # openstackdocstheme options -repository_name = 'openstack/neutron-lib' -bug_project = 'neutron' -bug_tag = 'api-ref' +openstackdocs_repo_name = 'openstack/neutron-lib' +openstackdocs_bug_project = 'neutron' +openstackdocs_bug_tag = 'api-ref' +openstackdocs_auto_name = False release = '' # The short X.Y version. @@ -97,7 +98,7 @@ add_module_names = False show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for man page output ---------------------------------------------- @@ -141,11 +142,6 @@ pygments_style = 'sphinx' # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' -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/doc/requirements.txt b/doc/requirements.txt index bb2bb08cd..6fda01003 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,4 @@ -sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index d82dc5971..57542f474 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,9 +21,7 @@ # serve to show the default. import os -import subprocess import sys -import warnings # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -61,16 +59,6 @@ master_doc = 'index' project = u'Neutron Library' copyright = u'2015-present, OpenStack Foundation.' -# 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. -# -# Version info -from neutron_lib.version import version_info as neutron_lib_version -release = neutron_lib_version.release_string() -# The short X.Y version. -version = neutron_lib_version.version_string() - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None @@ -103,7 +91,7 @@ exclude_trees = [] show_authors = True # 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 = ['neutron_lib.'] @@ -156,11 +144,6 @@ html_theme = 'openstackdocs' # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' -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 @@ -237,9 +220,11 @@ latex_elements = { # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/neutron-lib' -bug_project = 'neutron' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/neutron-lib' +openstackdocs_pdf_link = True +openstackdocs_bug_project = 'neutron' +openstackdocs_bug_tag = 'doc' +openstackdocs_auto_name = False linkcheck_anchors_ignore = [ # skip gerrit anchors diff --git a/lower-constraints.txt b/lower-constraints.txt index adf5c2a42..392658d73 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -29,7 +29,6 @@ mox3==0.20.0 msgpack-python==0.4.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.18.1 os-api-ref==1.4.0 os-client-config==1.28.0 os-ken==0.3.0 @@ -65,7 +64,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 repoze.lru==0.7 requests==2.14.2 requestsexceptions==1.2.0 @@ -73,8 +72,6 @@ rfc3986==0.3.1 Routes==2.3.1 setproctitle==1.1.10 snowballstemmer==1.2.1 -Sphinx==1.6.2 -sphinxcontrib-websupport==1.0.1 SQLAlchemy==1.2.0 sqlalchemy-migrate==0.11.0 sqlparse==0.2.2 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 255ccdb91..3775f3d92 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -93,7 +93,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,11 +142,6 @@ html_static_path = ['_static'] # 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 = '%b %d, %Y' -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 @@ -276,6 +271,7 @@ texinfo_documents = [ locale_dirs = ['locale/'] # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/neutron-lib' -bug_project = 'neutron' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/neutron-lib' +openstackdocs_bug_project = 'neutron' +openstackdocs_bug_tag = 'doc' +openstackdocs_auto_name = False diff --git a/test-requirements.txt b/test-requirements.txt index 7b3dd3a17..1481c1541 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,7 +10,7 @@ fixtures>=3.0.0 # Apache-2.0/BSD flake8-import-order==0.12 # LGPLv3 python-subunit>=1.0.0 # Apache-2.0/BSD oslotest>=3.2.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 stestr>=1.0.0 # Apache-2.0 testresources>=2.0.0 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD