From 27290fd297d0bcf8ed1c82e4a21df82af494ba97 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 23 Apr 2020 22:21:04 -0700 Subject: [PATCH 1/3] Sphinx 3.0 removed deprecated extra args in add_directive() --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4724853801..613f38dca5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -379,9 +379,9 @@ def app_role(role, rawtext, text, lineno, inliner, options={}, content=[]): def setup(app): app.add_role('app', app_role) - app.add_directive('frontmatter', FrontMatter, 1, (0, 0, 0)) - app.add_directive('mainmatter', MainMatter, 1, (0, 0, 0)) - app.add_directive('backmatter', BackMatter, 1, (0, 0, 0)) + app.add_directive('frontmatter', FrontMatter) + app.add_directive('mainmatter', MainMatter) + app.add_directive('backmatter', BackMatter) app.connect('autodoc-process-signature', resig) From 0d52baa965addef225e88bd2132c577b3fccf58f Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 24 Apr 2020 00:40:28 -0700 Subject: [PATCH 2/3] Exclude duplicate members `response` and `session` from `request` module to avoid Sphinx warnings: src/pyramid/request.py:docstring of pyramid.request.Request.response:1: WARNING: duplicate object description of pyramid.request.Request.response, other instance in api/request, use :noindex: for one of them src/pyramid/request.py:docstring of pyramid.request.Request.session:1: WARNING: duplicate object description of pyramid.request.Request.session, other instance in api/request, use :noindex: for one of them --- docs/api/request.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/request.rst b/docs/api/request.rst index ed7f91e912..edd319864e 100644 --- a/docs/api/request.rst +++ b/docs/api/request.rst @@ -14,7 +14,7 @@ model_url, resource_url, resource_path, set_property, effective_principals, authenticated_userid, unauthenticated_userid, has_permission, - invoke_exception_view, localizer + invoke_exception_view, localizer, response, session .. attribute:: context From 1a575dc3e506ff8b43bba31363bcda3fd94e57b4 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Fri, 24 Apr 2020 05:56:50 -0700 Subject: [PATCH 3/3] Suppress case-sensitivity warnings on terms in glossary --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index 8aeb1f4f8f..74f5cfbbd5 100644 --- a/tox.ini +++ b/tox.ini @@ -33,14 +33,14 @@ deps = [testenv:docs] whitelist_externals = make commands = - make -C docs {posargs:doctest html epub} BUILDDIR={envdir} "SPHINXOPTS=-W -E" + make -C docs {posargs:doctest html epub} BUILDDIR={envdir} "SPHINXOPTS=-W -E -D suppress_warnings=ref.term" extras = docs [testenv:pdf] whitelist_externals = make commands = - make -C docs latexpdf BUILDDIR={envdir} "SPHINXOPTS=-W -E" + make -C docs latexpdf BUILDDIR={envdir} "SPHINXOPTS=-W -E -D suppress_warnings=ref.term" extras = docs