diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 6c602b6f78..32a69d78e3 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -92,12 +92,12 @@ add_module_names = False show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # openstackdocstheme options -repository_name = 'openstack/glance' -bug_project = 'glance' -bug_tag = 'api-ref' +openstackdocs_repo_name = 'openstack/glance' +openstackdocs_bug_project = 'glance' +openstackdocs_bug_tag = 'api-ref' # -- Options for man page output ---------------------------------------------- @@ -141,11 +141,6 @@ bug_tag = 'api-ref' # 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 7b3b6d9d59..b9abc4b8af 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,10 +1,10 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD +sphinx>=2.0.0,!=2.1.0 # BSD os-api-ref>=1.4.0 # Apache-2.0 -openstackdocstheme>=1.20.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 sphinxcontrib-apidoc>=0.2.0 # BSD whereto>=0.3.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index e4202f785c..468cb1f314 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -51,9 +51,9 @@ extensions = ['stevedore.sphinxext', ] # openstackdocstheme options -repository_name = 'openstack/glance' -bug_project = 'glance' -bug_tag = 'documentation' +openstackdocs_repo_name = 'openstack/glance' +openstackdocs_bug_project = 'glance' +openstackdocs_bug_tag = 'documentation' # sphinxcontrib.apidoc options apidoc_module_dir = '../../glance' @@ -137,7 +137,7 @@ add_module_names = True 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 = ['glance.'] diff --git a/lower-constraints.txt b/lower-constraints.txt index 42bbcb8712..a403d54e0a 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -55,7 +55,6 @@ msgpack==0.5.6 netaddr==0.7.19 netifaces==0.10.6 networkx==1.11 -openstackdocstheme==1.20.0 os-api-ref==1.4.0 os-client-config==1.29.0 os-testr==1.0.0 @@ -104,7 +103,6 @@ python-swiftclient==3.2.0 pytz==2018.3 PyYAML==3.12 qpid-python==0.26 -reno==2.5.0 repoze.lru==0.7 requests==2.14.2 requestsexceptions==1.4.0 @@ -116,8 +114,6 @@ simplegeneric==0.8.1 six==1.10.0 smmap2==2.0.3 snowballstemmer==1.2.1 -Sphinx==1.6.2 -sphinxcontrib-websupport==1.0.1 sqlalchemy-migrate==0.11.0 SQLAlchemy==1.0.10 sqlparse==0.2.2 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 4d7fa9946d..05a0e5b0c5 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -31,8 +31,6 @@ # -- General configuration ------------------------------------------------ -import openstackdocstheme - # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' @@ -40,6 +38,7 @@ import openstackdocstheme # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'openstackdocstheme', 'reno.sphinxext', ] @@ -93,7 +92,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 = [] @@ -101,6 +100,12 @@ pygments_style = 'sphinx' # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/glance' +openstackdocs_bug_project = 'glance' +openstackdocs_auto_name = False +openstackdocs_bug_tag = 'releasenotes' + # -- Options for HTML output ---------------------------------------------- @@ -113,10 +118,6 @@ html_theme = 'openstackdocs' # documentation. # html_theme_options = {} -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] -html_theme_path = [openstackdocstheme.get_html_theme_path()] - # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None