From 81cb1dc3207e05d2fd201aee7ded8a5ea0bf0db0 Mon Sep 17 00:00:00 2001 From: Devon Stewart Date: Tue, 13 Feb 2024 22:07:11 -0800 Subject: [PATCH 1/4] Tracking requirements for docs --- docs/requirements.in | 9 ++++ docs/requirements.txt | 117 +++++++++++++++++++++++++++++------------- 2 files changed, 91 insertions(+), 35 deletions(-) create mode 100644 docs/requirements.in diff --git a/docs/requirements.in b/docs/requirements.in new file mode 100644 index 0000000..b6143d1 --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,9 @@ +typing_extensions>=4,<5 +Flask>=2.0.0 +Werkzeug>=2,<4 +aiohttp>=3.6.2 +requests>=2.25.1 +pyseto>=^1.6.11 +protobuf>=^4.21.8 +urllib3>=1.26,<3 +aiohttp-retry>=2.8.3 diff --git a/docs/requirements.txt b/docs/requirements.txt index cf3727c..8a10412 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,35 +1,82 @@ -aiohttp==3.9.2; python_version >= "3.6" -appdirs==1.4.4; python_full_version >= "3.6.1" and python_full_version < "4.0.0" -async-timeout==3.0.1; python_full_version >= "3.5.3" and python_version >= "3.6" -attrs==20.3.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6" -beautifulsoup4==4.9.3; python_full_version >= "3.6.0" -bs4==0.0.1; python_full_version >= "3.6.0" -chardet==3.0.4; python_version >= "3.6" -click==7.1.2; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" -cssselect==1.1.0; python_full_version >= "3.6.0" -fake-useragent==0.1.11; python_full_version >= "3.6.0" -flask==1.1.2; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.5.0") -idna==3.1; python_version >= "3.6" -itsdangerous==1.1.0; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" -jinja2==2.11.2; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" -lxml==4.6.2; python_full_version >= "3.6.0" -markupsafe==1.1.1; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" -multidict==5.1.0; python_version >= "3.6" -parse==1.19.0; python_full_version >= "3.6.0" -pyee==8.1.0; python_full_version >= "3.6.1" and python_full_version < "4.0.0" -pyppeteer==0.2.5; python_full_version >= "3.6.1" and python_full_version < "4.0.0" -pyquery==1.4.3; python_full_version >= "3.6.0" -requests-html==0.10.0; python_full_version >= "3.6.0" -requests==2.15.1; python_full_version >= "3.6.0" -six==1.15.0; python_full_version >= "3.6.0" -soupsieve==2.1; python_version >= "3.5" and python_full_version >= "3.6.0" -tqdm==4.56.0; python_full_version >= "3.6.1" and python_full_version < "4.0.0" -typing-extensions==3.7.4.3 -urllib3==1.26.2; python_full_version >= "3.6.1" and python_version < "4" and python_full_version < "4.0.0" -w3lib==1.22.0; python_full_version >= "3.6.0" -websockets==8.1; python_full_version >= "3.6.1" and python_full_version < "4.0.0" -werkzeug==1.0.1; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.5.0") -yarl==1.6.3; python_version >= "3.6" -sphinx_autodoc_typehints -alabaster -sphinx-click==2.7.1 +# +# This file is autogenerated by pip-compile with Python 3.10 +# by the following command: +# +# pip-compile +# +aiohttp==3.9.3 + # via + # -r requirements.in + # aiohttp-retry +aiohttp-retry==2.8.3 + # via -r requirements.in +aiosignal==1.3.1 + # via aiohttp +argon2-cffi==23.1.0 + # via pyseto +argon2-cffi-bindings==21.2.0 + # via argon2-cffi +async-timeout==4.0.3 + # via aiohttp +attrs==23.2.0 + # via aiohttp +blinker==1.7.0 + # via flask +certifi==2024.2.2 + # via requests +cffi==1.16.0 + # via + # argon2-cffi-bindings + # cryptography +charset-normalizer==3.3.2 + # via requests +click==8.1.7 + # via flask +cryptography==42.0.2 + # via pyseto +flask==3.0.2 + # via -r requirements.in +frozenlist==1.4.1 + # via + # aiohttp + # aiosignal +idna==3.6 + # via + # requests + # yarl +iso8601==2.1.0 + # via pyseto +itsdangerous==2.1.2 + # via flask +jinja2==3.1.3 + # via flask +markupsafe==2.1.5 + # via + # jinja2 + # werkzeug +multidict==6.0.5 + # via + # aiohttp + # yarl +protobuf==5.26.0rc2 + # via -r requirements.in +pycparser==2.21 + # via cffi +pycryptodomex==3.20.0 + # via pyseto +pyseto==1.7.8 + # via -r requirements.in +requests==2.31.0 + # via -r requirements.in +typing-extensions==4.9.0 + # via -r requirements.in +urllib3==2.2.0 + # via + # -r requirements.in + # requests +werkzeug==3.0.1 + # via + # -r requirements.in + # flask +yarl==1.9.4 + # via aiohttp From 094d16fd46e423a9bb39fc2e90c012cfb8dba924 Mon Sep 17 00:00:00 2001 From: Devon Stewart Date: Tue, 13 Feb 2024 22:07:18 -0800 Subject: [PATCH 2/4] Adding RTD config --- readthedocs.yaml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 readthedocs.yaml diff --git a/readthedocs.yaml b/readthedocs.yaml new file mode 100644 index 0000000..627384f --- /dev/null +++ b/readthedocs.yaml @@ -0,0 +1,17 @@ +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Declare the Python requirements required to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt From 783089492b6350aebf9de402d7d8f849a360dab6 Mon Sep 17 00:00:00 2001 From: Devon Stewart Date: Wed, 14 Feb 2024 11:41:28 -0800 Subject: [PATCH 3/4] Widening aiohttp --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index b807d8b..176d7a8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,7 +14,7 @@ python = ">=3.9,<4.0" typing_extensions = "^4" Flask = ">=2.0.0" Werkzeug = ">=2,<4" -aiohttp = "^3.6.2" +aiohttp = ">=3.6.2" requests = "^2.25.1" pyseto = "^1.6.11" protobuf = "^4.21.8" From 315ef2ac34cd58ea6ef0d48e3d6915f1577cde36 Mon Sep 17 00:00:00 2001 From: Devon Stewart Date: Wed, 14 Feb 2024 11:28:58 -0800 Subject: [PATCH 4/4] Adding missing sphinx extensions --- docs/requirements.in | 2 ++ docs/requirements.txt | 46 +++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 46 insertions(+), 2 deletions(-) diff --git a/docs/requirements.in b/docs/requirements.in index b6143d1..b0df211 100644 --- a/docs/requirements.in +++ b/docs/requirements.in @@ -7,3 +7,5 @@ pyseto>=^1.6.11 protobuf>=^4.21.8 urllib3>=1.26,<3 aiohttp-retry>=2.8.3 +sphinx-autodoc-typehints>=1.0.0,<3 +sphinx_click>=4.0.0,<6.0.0 diff --git a/docs/requirements.txt b/docs/requirements.txt index 8a10412..f4ee401 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -12,6 +12,8 @@ aiohttp-retry==2.8.3 # via -r requirements.in aiosignal==1.3.1 # via aiohttp +alabaster==0.7.16 + # via sphinx argon2-cffi==23.1.0 # via pyseto argon2-cffi-bindings==21.2.0 @@ -20,6 +22,8 @@ async-timeout==4.0.3 # via aiohttp attrs==23.2.0 # via aiohttp +babel==2.14.0 + # via sphinx blinker==1.7.0 # via flask certifi==2024.2.2 @@ -31,9 +35,15 @@ cffi==1.16.0 charset-normalizer==3.3.2 # via requests click==8.1.7 - # via flask + # via + # flask + # sphinx-click cryptography==42.0.2 # via pyseto +docutils==0.20.1 + # via + # sphinx + # sphinx-click flask==3.0.2 # via -r requirements.in frozenlist==1.4.1 @@ -44,12 +54,16 @@ idna==3.6 # via # requests # yarl +imagesize==1.4.1 + # via sphinx iso8601==2.1.0 # via pyseto itsdangerous==2.1.2 # via flask jinja2==3.1.3 - # via flask + # via + # flask + # sphinx markupsafe==2.1.5 # via # jinja2 @@ -58,16 +72,44 @@ multidict==6.0.5 # via # aiohttp # yarl +packaging==23.2 + # via sphinx protobuf==5.26.0rc2 # via -r requirements.in pycparser==2.21 # via cffi pycryptodomex==3.20.0 # via pyseto +pygments==2.17.2 + # via sphinx pyseto==1.7.8 # via -r requirements.in requests==2.31.0 + # via + # -r requirements.in + # sphinx +snowballstemmer==2.2.0 + # via sphinx +sphinx==7.2.6 + # via + # sphinx-autodoc-typehints + # sphinx-click +sphinx-autodoc-typehints==2.0.0 + # via -r requirements.in +sphinx-click==5.1.0 # via -r requirements.in +sphinxcontrib-applehelp==1.0.8 + # via sphinx +sphinxcontrib-devhelp==1.0.6 + # via sphinx +sphinxcontrib-htmlhelp==2.0.5 + # via sphinx +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==1.0.7 + # via sphinx +sphinxcontrib-serializinghtml==1.1.10 + # via sphinx typing-extensions==4.9.0 # via -r requirements.in urllib3==2.2.0