From ef8033a26ed5671465a42a3a7a43ebdcb3d9471b Mon Sep 17 00:00:00 2001 From: Eugenio Parodi Date: Tue, 9 Aug 2022 11:29:28 +0100 Subject: [PATCH] updated .venv dependencies and sphynx version --- docs/requirements.txt | 100 ++++++++++++++++------------------- docs/source/conf.py | 10 ++-- docs/sphynx.001.signal.patch | 21 ++++---- 3 files changed, 63 insertions(+), 68 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index b4bc371d..2494dfa5 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,62 +1,56 @@ alabaster==0.7.12 -attrs==20.3.0 -Babel==2.9.0 -bleach==3.3.0 -build==0.3.1.post1 -certifi==2020.12.5 -cffi==1.14.5 -chardet==4.0.0 -colorama==0.4.4 -cryptography==3.4.7 -docutils==0.17 -flake8==3.9.0 -gitdb==4.0.7 -GitPython==3.1.14 -idna==2.10 -imagesize==1.2.0 -importlib-metadata==3.10.0 +attrs==22.1.0 +Babel==2.10.3 +bleach==5.0.1 +build==0.8.0 +certifi==2022.6.15 +cffi==1.15.1 +charset-normalizer==2.1.0 +commonmark==0.9.1 +cryptography==37.0.4 +docutils==0.17.1 +flake8==5.0.4 +idna==3.3 +imagesize==1.4.1 +importlib-metadata==4.12.0 iniconfig==1.1.1 -jeepney==0.6.0 -Jinja2==2.11.3 -keyring==23.0.1 -m2r==0.2.1 -MarkupSafe==1.1.1 -mccabe==0.6.1 -mistune==0.8.4 -packaging==20.9 -pep517==0.10.0 -pkginfo==1.7.0 -pluggy==0.13.1 -py==1.10.0 -pycodestyle==2.7.0 -pycparser==2.20 -pyflakes==2.3.1 -Pygments==2.8.1 -pyparsing==2.4.7 -pytest==6.2.3 -pytz==2021.1 -readme-renderer==29.0 -requests==2.25.1 +jeepney==0.8.0 +Jinja2==3.1.2 +keyring==23.8.2 +MarkupSafe==2.1.1 +mccabe==0.7.0 +packaging==21.3 +pep517==0.13.0 +pkginfo==1.8.3 +pluggy==1.0.0 +py==1.11.0 +pycodestyle==2.9.1 +pycparser==2.21 +pyflakes==2.5.0 +Pygments==2.12.0 +pyparsing==3.0.9 +pytest==7.1.2 +pytz==2022.1 +readme-renderer==36.0 +requests==2.28.1 requests-toolbelt==0.9.1 -rfc3986==1.4.0 -SecretStorage==3.3.1 -six==1.15.0 -smmap==4.0.0 -snowballstemmer==2.1.0 -Sphinx==3.5.3 -sphinx-autodocgen==1.2 +rfc3986==2.0.0 +rich==12.5.1 +SecretStorage==3.3.2 +six==1.16.0 +snowballstemmer==2.2.0 +Sphinx==5.1.1 +sphinx-autodocgen==1.3 sphinx-epytext==0.0.4 -sphinx-rtd-theme==0.5.1 +sphinx-rtd-theme==1.0.0 sphinxcontrib-applehelp==1.0.2 sphinxcontrib-devhelp==1.0.2 -sphinxcontrib-fulltoc==1.2.0 -sphinxcontrib-htmlhelp==1.0.3 +sphinxcontrib-htmlhelp==2.0.0 sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.3 -sphinxcontrib-serializinghtml==1.1.4 -toml==0.10.2 -tqdm==4.59.0 -twine==3.4.1 -urllib3==1.26.4 +sphinxcontrib-serializinghtml==1.1.5 +tomli==2.0.1 +twine==4.0.1 +urllib3==1.26.11 webencodings==0.5.1 -zipp==3.4.1 +zipp==3.8.1 diff --git a/docs/source/conf.py b/docs/source/conf.py index 2706e798..6eeb011b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -55,7 +55,7 @@ exclude_patterns = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# + html_theme = 'sphinx_rtd_theme' # read-the-docs theme looks better than the default "classic" one but has bugs e.g. no table wrapping html_theme_options = { @@ -77,11 +77,11 @@ html_theme_options = { # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -html_context = {'css_files': [ +html_css_files = [ # Workaround for RTD 0.4.3 bug https://github.com/readthedocs/sphinx_rtd_theme/issues/117 - '_static/theme_overrides.css', # override wide tables in RTD theme - '_static/ttk.css' -]} + 'theme_overrides.css', # override wide tables in RTD theme + 'ttk.css' +] # html_theme = 'bizstyle' diff --git a/docs/sphynx.001.signal.patch b/docs/sphynx.001.signal.patch index a4346281..77d848bd 100644 --- a/docs/sphynx.001.signal.patch +++ b/docs/sphynx.001.signal.patch @@ -1,19 +1,20 @@ ---- .venv/lib/python3.8/site-packages/sphinx/domains/python.py 2022-03-08 11:00:06.152347159 +0000 -+++ .venv/lib/python3.8/site-packages/sphinx/domains/python.py 2022-03-08 11:03:07.292940495 +0000 -@@ -795,6 +795,7 @@ +--- .venv/lib/python3.X/site-packages/sphinx/domains/python.py 2022-03-08 11:00:06.152347159 +0000 ++++ .venv/lib/python3.X/site-packages/sphinx/domains/python.py 2022-03-08 11:03:07.292940495 +0000 +@@ -768,6 +768,7 @@ - option_spec = PyObject.option_spec.copy() + option_spec: OptionSpec = PyObject.option_spec.copy() option_spec.update({ + 'signal': directives.flag, 'abstractmethod': directives.flag, 'async': directives.flag, 'classmethod': directives.flag, -@@ -813,6 +814,8 @@ - prefix = [] +@@ -787,6 +788,9 @@ if 'final' in self.options: - prefix.append('final') + prefix.append(nodes.Text('final')) + prefix.append(addnodes.desc_sig_space()) + if 'signal' in self.options: -+ prefix.append('signal') ++ prefix.append(nodes.Text('signal')) ++ prefix.append(addnodes.desc_sig_space()) if 'abstractmethod' in self.options: - prefix.append('abstract') - if 'async' in self.options: + prefix.append(nodes.Text('abstract')) + prefix.append(addnodes.desc_sig_space())