From 3bb1fb2ce07297ca30e1de64a30800f7bac52d6a Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 15:31:05 -0400 Subject: [PATCH 01/21] create .readthedocs.yaml --- .readthedocs.yaml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..2e8c7992 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,31 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, 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 \ No newline at end of file From db4064049df00f19ddc0e783ccbfa6e19033ad10 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 15:36:02 -0400 Subject: [PATCH 02/21] add newline --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2e8c7992..7bad5267 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -28,4 +28,4 @@ sphinx: # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html # python: # install: -# - requirements: docs/requirements.txt \ No newline at end of file +# - requirements: docs/requirements.txt From 39ca8ccc3d4fa552f4cda01fcf28d8c8700f1259 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 16:05:39 -0400 Subject: [PATCH 03/21] update specs.rst addressing https://stackoverflow.com/a/56469300 (sphinx >=1.3) --- docs/specs.rst | 52 +++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/specs.rst b/docs/specs.rst index b4f61854..87124b54 100644 --- a/docs/specs.rst +++ b/docs/specs.rst @@ -9,7 +9,7 @@ python-arango. ArangoClient ============ -.. autoclass:: arango.client.ArangoClient +.. autoclass:: arango.client::ArangoClient :members: .. _AsyncDatabase: @@ -17,7 +17,7 @@ ArangoClient AsyncDatabase ============= -.. autoclass:: arango.database.AsyncDatabase +.. autoclass:: arango.database::AsyncDatabase :inherited-members: :members: @@ -26,7 +26,7 @@ AsyncDatabase AsyncJob ======== -.. autoclass:: arango.job.AsyncJob +.. autoclass:: arango.job::AsyncJob :members: .. _AQL: @@ -34,7 +34,7 @@ AsyncJob AQL ==== -.. autoclass:: arango.aql.AQL +.. autoclass:: arango.aql::AQL :members: .. _AQLQueryCache: @@ -42,7 +42,7 @@ AQL AQLQueryCache ============= -.. autoclass:: arango.aql.AQLQueryCache +.. autoclass:: arango.aql::AQLQueryCache :members: .. _Backup: @@ -50,7 +50,7 @@ AQLQueryCache Backup ====== -.. autoclass:: arango.backup.Backup +.. autoclass:: arango.backup::Backup :inherited-members: :members: @@ -59,7 +59,7 @@ Backup BatchDatabase ============= -.. autoclass:: arango.database.BatchDatabase +.. autoclass:: arango.database::BatchDatabase :inherited-members: :members: @@ -68,7 +68,7 @@ BatchDatabase BatchJob ======== -.. autoclass:: arango.job.BatchJob +.. autoclass:: arango.job::BatchJob :members: .. _Cluster: @@ -76,7 +76,7 @@ BatchJob Cluster ======= -.. autoclass:: arango.cluster.Cluster +.. autoclass:: arango.cluster::Cluster :members: .. _Collection: @@ -84,7 +84,7 @@ Cluster Collection ========== -.. autoclass:: arango.collection.Collection +.. autoclass:: arango.collection::Collection :members: .. _Cursor: @@ -92,7 +92,7 @@ Collection Cursor ====== -.. autoclass:: arango.cursor.Cursor +.. autoclass:: arango.cursor::Cursor :members: .. _DefaultHTTPClient: @@ -100,7 +100,7 @@ Cursor DefaultHTTPClient ================= -.. autoclass:: arango.http.DefaultHTTPClient +.. autoclass:: arango.http::DefaultHTTPClient :members: .. _EdgeCollection: @@ -108,7 +108,7 @@ DefaultHTTPClient EdgeCollection ============== -.. autoclass:: arango.collection.EdgeCollection +.. autoclass:: arango.collection::EdgeCollection :members: .. _Foxx: @@ -116,7 +116,7 @@ EdgeCollection Foxx ==== -.. autoclass:: arango.foxx.Foxx +.. autoclass:: arango.foxx::Foxx :members: .. _Graph: @@ -124,7 +124,7 @@ Foxx Graph ===== -.. autoclass:: arango.graph.Graph +.. autoclass:: arango.graph::Graph :members: .. _HTTPClient: @@ -132,7 +132,7 @@ Graph HTTPClient ========== -.. autoclass:: arango.http.HTTPClient +.. autoclass:: arango.http::HTTPClient :members: .. _OverloadControlDatabase: @@ -140,7 +140,7 @@ HTTPClient OverloadControlDatabase ======================= -.. autoclass:: arango.database.OverloadControlDatabase +.. autoclass:: arango.database::OverloadControlDatabase :inherited-members: :members: @@ -149,7 +149,7 @@ OverloadControlDatabase Pregel ====== -.. autoclass:: arango.pregel.Pregel +.. autoclass:: arango.pregel::Pregel :members: .. _Replication: @@ -157,7 +157,7 @@ Pregel Replication =========== -.. autoclass:: arango.replication.Replication +.. autoclass:: arango.replication::Replication :members: .. _Request: @@ -165,7 +165,7 @@ Replication Request ======= -.. autoclass:: arango.request.Request +.. autoclass:: arango.request::Request :members: .. _Response: @@ -173,7 +173,7 @@ Request Response ======== -.. autoclass:: arango.response.Response +.. autoclass:: arango.response::Response :members: .. _StandardCollection: @@ -181,7 +181,7 @@ Response StandardCollection ================== -.. autoclass:: arango.collection.StandardCollection +.. autoclass:: arango.collection::StandardCollection :inherited-members: :members: @@ -190,7 +190,7 @@ StandardCollection StandardDatabase ================ -.. autoclass:: arango.database.StandardDatabase +.. autoclass:: arango.database::StandardDatabase :inherited-members: :members: @@ -199,7 +199,7 @@ StandardDatabase TransactionDatabase =================== -.. autoclass:: arango.database.TransactionDatabase +.. autoclass:: arango.database::TransactionDatabase :inherited-members: :members: @@ -208,7 +208,7 @@ TransactionDatabase VertexCollection ================ -.. autoclass:: arango.collection.VertexCollection +.. autoclass:: arango.collection::VertexCollection :members: .. _WriteAheadLog: @@ -216,5 +216,5 @@ VertexCollection WAL ==== -.. autoclass:: arango.wal.WAL +.. autoclass:: arango.wal::WAL :members: From c926e1ce02ed147d405600041d5911cc497321b7 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 16:30:26 -0400 Subject: [PATCH 04/21] update sys path addressing https://stackoverflow.com/a/44980548 --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 9f432aee..bb7fa58f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,3 +1,6 @@ +import sys, os +sys.path.insert(0, os.path.abspath('..')) + project = "python-arango" copyright = "2016-2022, Joohwan Oh" author = "Joohwan Oh" From caad62dcbccb6e4fca60c339835f431ae44bca3c Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 16:32:17 -0400 Subject: [PATCH 05/21] fix: lint --- docs/conf.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index bb7fa58f..77fe6bb8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,7 @@ -import sys, os -sys.path.insert(0, os.path.abspath('..')) +import os +import sys + +sys.path.insert(0, os.path.abspath("..")) project = "python-arango" copyright = "2016-2022, Joohwan Oh" From 68f6f205f353c2a91a77275aebc20502fdece454 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 16:38:24 -0400 Subject: [PATCH 06/21] update sys path --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 77fe6bb8..57793cc1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,9 @@ import os import sys -sys.path.insert(0, os.path.abspath("..")) +sys.path.insert(0, os.path.abspath(".")) +sys.path.insert(0, os.path.abspath("../")) +sys.path.insert(1, os.path.dirname(os.path.abspath("../")) + os.sep + "arango") project = "python-arango" copyright = "2016-2022, Joohwan Oh" From 8879e2411c8675f6b1b10ddff0f55523b01b99e8 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 16:44:36 -0400 Subject: [PATCH 07/21] temp: add docs/requirements.txt --- .readthedocs.yaml | 6 +++--- docs/requirements.txt | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7bad5267..bb9d1590 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -26,6 +26,6 @@ sphinx: # Optional but recommended, 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 +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..2db91f6c --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,7 @@ +urllib3>=1.26.0 +requests +requests_toolbelt +PyJWT +setuptools>=42 +importlib_metadata>=4.7.1 +packaging>=23.1 \ No newline at end of file From 15c24f3dbebb64830248e3fc4419031ede7217d6 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 16:50:08 -0400 Subject: [PATCH 08/21] temp: autodoc_mock_imports --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 57793cc1..322dde12 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,6 +18,7 @@ html_static_path = ["static"] html_theme = "sphinx_rtd_theme" master_doc = "index" +autodoc_mock_imports = ["importlib_metadata"] autodoc_member_order = "bysource" From 44da0982fe8bb87b87f0d42abf8565c51fb97ee5 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 16:55:10 -0400 Subject: [PATCH 09/21] remove docs/requirements.txt --- .readthedocs.yaml | 6 +++--- docs/requirements.txt | 7 ------- 2 files changed, 3 insertions(+), 10 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index bb9d1590..7bad5267 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -26,6 +26,6 @@ sphinx: # Optional but recommended, 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 +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 2db91f6c..00000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -urllib3>=1.26.0 -requests -requests_toolbelt -PyJWT -setuptools>=42 -importlib_metadata>=4.7.1 -packaging>=23.1 \ No newline at end of file From 56ec1bd132a95dd2e46e3e4bc31bf68c95e7d690 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 16:58:23 -0400 Subject: [PATCH 10/21] Update conf.py --- docs/conf.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 322dde12..2e8e36ff 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,7 @@ import os import sys -sys.path.insert(0, os.path.abspath(".")) -sys.path.insert(0, os.path.abspath("../")) -sys.path.insert(1, os.path.dirname(os.path.abspath("../")) + os.sep + "arango") +sys.path.insert(0, os.path.abspath("..")) project = "python-arango" copyright = "2016-2022, Joohwan Oh" @@ -18,7 +16,7 @@ html_static_path = ["static"] html_theme = "sphinx_rtd_theme" master_doc = "index" -autodoc_mock_imports = ["importlib_metadata"] +autodoc_mock_imports = ["importlib_metadata", "jwt"] autodoc_member_order = "bysource" From ef3c1918fbafbe8c18d19a419f9901dbf1f2cc17 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:00:41 -0400 Subject: [PATCH 11/21] update autodoc_mock_imports --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2e8e36ff..26e87ae4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,13 @@ html_static_path = ["static"] html_theme = "sphinx_rtd_theme" master_doc = "index" -autodoc_mock_imports = ["importlib_metadata", "jwt"] +autodoc_mock_imports = [ + "importlib_metadata", + "jwt", + "requests_toolbelt", + "requests", + "urllib3", +] autodoc_member_order = "bysource" From c67f1fb1241c224a4354840e1e1d0cec85d701f9 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:03:53 -0400 Subject: [PATCH 12/21] temp: disable sys path this should fail the readthedocs build: https://readthedocs.org/projects/python-driver-for-arangodb/builds/ --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 26e87ae4..a19b2c12 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,7 @@ import os import sys -sys.path.insert(0, os.path.abspath("..")) +# sys.path.insert(0, os.path.abspath("..")) project = "python-arango" copyright = "2016-2022, Joohwan Oh" From 79c7bef6e8e4f99852957181e96620c407463f62 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:05:53 -0400 Subject: [PATCH 13/21] revert last commit --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index a19b2c12..26e87ae4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,7 @@ import os import sys -# sys.path.insert(0, os.path.abspath("..")) +sys.path.insert(0, os.path.abspath("..")) project = "python-arango" copyright = "2016-2022, Joohwan Oh" From d11e42205a3d996414071a4780a9f89f29a7aa6b Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:06:17 -0400 Subject: [PATCH 14/21] attempt: undo specs.rst changes (the less changes the better) --- docs/specs.rst | 52 +++++++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/specs.rst b/docs/specs.rst index 87124b54..b4f61854 100644 --- a/docs/specs.rst +++ b/docs/specs.rst @@ -9,7 +9,7 @@ python-arango. ArangoClient ============ -.. autoclass:: arango.client::ArangoClient +.. autoclass:: arango.client.ArangoClient :members: .. _AsyncDatabase: @@ -17,7 +17,7 @@ ArangoClient AsyncDatabase ============= -.. autoclass:: arango.database::AsyncDatabase +.. autoclass:: arango.database.AsyncDatabase :inherited-members: :members: @@ -26,7 +26,7 @@ AsyncDatabase AsyncJob ======== -.. autoclass:: arango.job::AsyncJob +.. autoclass:: arango.job.AsyncJob :members: .. _AQL: @@ -34,7 +34,7 @@ AsyncJob AQL ==== -.. autoclass:: arango.aql::AQL +.. autoclass:: arango.aql.AQL :members: .. _AQLQueryCache: @@ -42,7 +42,7 @@ AQL AQLQueryCache ============= -.. autoclass:: arango.aql::AQLQueryCache +.. autoclass:: arango.aql.AQLQueryCache :members: .. _Backup: @@ -50,7 +50,7 @@ AQLQueryCache Backup ====== -.. autoclass:: arango.backup::Backup +.. autoclass:: arango.backup.Backup :inherited-members: :members: @@ -59,7 +59,7 @@ Backup BatchDatabase ============= -.. autoclass:: arango.database::BatchDatabase +.. autoclass:: arango.database.BatchDatabase :inherited-members: :members: @@ -68,7 +68,7 @@ BatchDatabase BatchJob ======== -.. autoclass:: arango.job::BatchJob +.. autoclass:: arango.job.BatchJob :members: .. _Cluster: @@ -76,7 +76,7 @@ BatchJob Cluster ======= -.. autoclass:: arango.cluster::Cluster +.. autoclass:: arango.cluster.Cluster :members: .. _Collection: @@ -84,7 +84,7 @@ Cluster Collection ========== -.. autoclass:: arango.collection::Collection +.. autoclass:: arango.collection.Collection :members: .. _Cursor: @@ -92,7 +92,7 @@ Collection Cursor ====== -.. autoclass:: arango.cursor::Cursor +.. autoclass:: arango.cursor.Cursor :members: .. _DefaultHTTPClient: @@ -100,7 +100,7 @@ Cursor DefaultHTTPClient ================= -.. autoclass:: arango.http::DefaultHTTPClient +.. autoclass:: arango.http.DefaultHTTPClient :members: .. _EdgeCollection: @@ -108,7 +108,7 @@ DefaultHTTPClient EdgeCollection ============== -.. autoclass:: arango.collection::EdgeCollection +.. autoclass:: arango.collection.EdgeCollection :members: .. _Foxx: @@ -116,7 +116,7 @@ EdgeCollection Foxx ==== -.. autoclass:: arango.foxx::Foxx +.. autoclass:: arango.foxx.Foxx :members: .. _Graph: @@ -124,7 +124,7 @@ Foxx Graph ===== -.. autoclass:: arango.graph::Graph +.. autoclass:: arango.graph.Graph :members: .. _HTTPClient: @@ -132,7 +132,7 @@ Graph HTTPClient ========== -.. autoclass:: arango.http::HTTPClient +.. autoclass:: arango.http.HTTPClient :members: .. _OverloadControlDatabase: @@ -140,7 +140,7 @@ HTTPClient OverloadControlDatabase ======================= -.. autoclass:: arango.database::OverloadControlDatabase +.. autoclass:: arango.database.OverloadControlDatabase :inherited-members: :members: @@ -149,7 +149,7 @@ OverloadControlDatabase Pregel ====== -.. autoclass:: arango.pregel::Pregel +.. autoclass:: arango.pregel.Pregel :members: .. _Replication: @@ -157,7 +157,7 @@ Pregel Replication =========== -.. autoclass:: arango.replication::Replication +.. autoclass:: arango.replication.Replication :members: .. _Request: @@ -165,7 +165,7 @@ Replication Request ======= -.. autoclass:: arango.request::Request +.. autoclass:: arango.request.Request :members: .. _Response: @@ -173,7 +173,7 @@ Request Response ======== -.. autoclass:: arango.response::Response +.. autoclass:: arango.response.Response :members: .. _StandardCollection: @@ -181,7 +181,7 @@ Response StandardCollection ================== -.. autoclass:: arango.collection::StandardCollection +.. autoclass:: arango.collection.StandardCollection :inherited-members: :members: @@ -190,7 +190,7 @@ StandardCollection StandardDatabase ================ -.. autoclass:: arango.database::StandardDatabase +.. autoclass:: arango.database.StandardDatabase :inherited-members: :members: @@ -199,7 +199,7 @@ StandardDatabase TransactionDatabase =================== -.. autoclass:: arango.database::TransactionDatabase +.. autoclass:: arango.database.TransactionDatabase :inherited-members: :members: @@ -208,7 +208,7 @@ TransactionDatabase VertexCollection ================ -.. autoclass:: arango.collection::VertexCollection +.. autoclass:: arango.collection.VertexCollection :members: .. _WriteAheadLog: @@ -216,5 +216,5 @@ VertexCollection WAL ==== -.. autoclass:: arango.wal::WAL +.. autoclass:: arango.wal.WAL :members: From 8eb056382359740b451f05e3dde54805f0a18d07 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:12:05 -0400 Subject: [PATCH 15/21] temp: remove `requests` & `urlib3` from autodoc_mock_imports --- docs/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 26e87ae4..42ac47da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,8 +20,6 @@ "importlib_metadata", "jwt", "requests_toolbelt", - "requests", - "urllib3", ] autodoc_member_order = "bysource" From 1012e5d7be70327418bc2001dce00e7b7e9e6181 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:16:55 -0400 Subject: [PATCH 16/21] temp: remove `requests_toolbelt` from `autodoc_mock_imports` --- docs/conf.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 42ac47da..2e8e36ff 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,11 +16,7 @@ html_static_path = ["static"] html_theme = "sphinx_rtd_theme" master_doc = "index" -autodoc_mock_imports = [ - "importlib_metadata", - "jwt", - "requests_toolbelt", -] +autodoc_mock_imports = ["importlib_metadata", "jwt"] autodoc_member_order = "bysource" From 2616eadcbc0085c9a5d0effdd0114c1423479ad9 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:23:12 -0400 Subject: [PATCH 17/21] reintroduce docs/requirements.txt --- .readthedocs.yaml | 6 +++--- docs/requirements.txt | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7bad5267..bb9d1590 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -26,6 +26,6 @@ sphinx: # Optional but recommended, 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 +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..976bdfe9 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +requests_toolbelt From e8e6215cadbf7018772625e15202d2cfc97b4322 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:28:46 -0400 Subject: [PATCH 18/21] temp: disable `autodoc_mock_imports` --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2e8e36ff..0642b3f9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,7 @@ html_static_path = ["static"] html_theme = "sphinx_rtd_theme" master_doc = "index" -autodoc_mock_imports = ["importlib_metadata", "jwt"] +# autodoc_mock_imports = ["importlib_metadata", "jwt"] autodoc_member_order = "bysource" From f5c3896e510ae83f775574dda0173c3354c6d7ea Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:32:36 -0400 Subject: [PATCH 19/21] new: `importlib_metadata` in docs/requirements.txt --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 976bdfe9..037599ad 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ requests_toolbelt +importlib_metadata \ No newline at end of file From d4cf689c2762e69de49c2731459a4730e653cff4 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:48:04 -0400 Subject: [PATCH 20/21] new: `jwt` in `docs/requirements.txt` --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 037599ad..6a02df0e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ requests_toolbelt -importlib_metadata \ No newline at end of file +importlib_metadata +jwt From 0d3ac20036a3f0912100015893e1b1ad2032cfc9 Mon Sep 17 00:00:00 2001 From: Anthony Mahanna Date: Tue, 15 Aug 2023 17:48:10 -0400 Subject: [PATCH 21/21] remove: `autodoc_mock_imports` --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 0642b3f9..77fe6bb8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,6 @@ html_static_path = ["static"] html_theme = "sphinx_rtd_theme" master_doc = "index" -# autodoc_mock_imports = ["importlib_metadata", "jwt"] autodoc_member_order = "bysource"