Skip to content

Commit dc80beb

Browse files
committed
docs: Flatten sphinx JSON output and drop the package index page
1 parent 494d5d0 commit dc80beb

29 files changed

Lines changed: 44 additions & 20 deletions

File tree

‎.gitignore‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,21 @@ coverage.xml
3131

3232
# Sphinx
3333
sphinx/_build/
34-
sphinx/autoapi/
3534

36-
# Only the page JSON is committed. Everything else Sphinx writes there is not.
37-
sphinx/json/*
38-
!sphinx/json/autoapi
39-
!sphinx/json/index.fjson
35+
# autoapi writes the module sources next to conf.py. Only the json/ directory is tracked.
36+
sphinx/*/
37+
!sphinx/json/
38+
39+
# These Sphinx outputs in json/ are not committed.
40+
sphinx/json/.buildinfo
41+
sphinx/json/.doctrees
42+
sphinx/json/_sources
43+
sphinx/json/_static
44+
sphinx/json/environment.pickle
45+
sphinx/json/genindex.fjson
46+
sphinx/json/globalcontext.json
47+
sphinx/json/last_build
48+
sphinx/json/objects.inv
49+
sphinx/json/py-modindex.fjson
50+
sphinx/json/search.fjson
51+
sphinx/json/searchindex.json

‎sphinx/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ json:
1717

1818
clean:
1919
@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
20-
rm -rf "$(SOURCEDIR)autoapi"
20+
rm -rf "$(SOURCEDIR)auth0_api_python"

‎sphinx/conf.py‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,15 @@
77
extensions = ["autoapi.extension", "sphinx.ext.napoleon"]
88

99
autoapi_dirs = ["../src"]
10+
autoapi_root = "."
11+
autoapi_keep_files = True
12+
autoapi_add_toctree_entry = False
1013
autoapi_options = ["members", "undoc-members", "show-inheritance", "show-module-summary"]
14+
15+
exclude_patterns = [
16+
"_build",
17+
"Thumbs.db",
18+
".DS_Store",
19+
# Skip the package page, which lists the submodules and repeats the package docstring.
20+
"auth0_api_python/index.rst",
21+
]

‎sphinx/index.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@ auth0-api-python
33

44
.. toctree::
55
:hidden:
6+
:glob:
7+
8+
**
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"parents": [], "prev": {"link": "../../", "title": "auth0-api-python"}, "next": {"link": "../api_client/", "title": "auth0_api_python.api_client"}, "title": "auth0_api_python.act", "meta": null, "body": "<section id=\"module-auth0_api_python.act\">\n<span id=\"auth0-api-python-act\"></span><h1>auth0_api_python.act<a class=\"headerlink\" href=\"#module-auth0_api_python.act\" title=\"Link to this heading\">\u00b6</a></h1>\n<p>Helpers for working with the <cite>act</cite> claim on verified access token claims.</p>\n<section id=\"attributes\">\n<h2>Attributes<a class=\"headerlink\" href=\"#attributes\" title=\"Link to this heading\">\u00b6</a></h2>\n<table class=\"autosummary longtable docutils align-default\">\n<tbody>\n<tr class=\"row-odd\"><td><p><a class=\"reference internal\" href=\"#auth0_api_python.act.INVALID_ACT_CLAIM_MESSAGE\" title=\"auth0_api_python.act.INVALID_ACT_CLAIM_MESSAGE\"><code class=\"xref py py-obj docutils literal notranslate\"><span class=\"pre\">INVALID_ACT_CLAIM_MESSAGE</span></code></a></p></td>\n<td><p></p></td>\n</tr>\n</tbody>\n</table>\n</section>\n<section id=\"functions\">\n<h2>Functions<a class=\"headerlink\" href=\"#functions\" title=\"Link to this heading\">\u00b6</a></h2>\n<table class=\"autosummary longtable docutils align-default\">\n<tbody>\n<tr class=\"row-odd\"><td><p><a class=\"reference internal\" href=\"#auth0_api_python.act.get_current_actor\" title=\"auth0_api_python.act.get_current_actor\"><code class=\"xref py py-obj docutils literal notranslate\"><span class=\"pre\">get_current_actor</span></code></a>(\u2192\u00a0Optional[str])</p></td>\n<td><p>Return the current actor from the outermost <cite>act.sub</cite>, if present.</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><a class=\"reference internal\" href=\"#auth0_api_python.act.get_delegation_chain\" title=\"auth0_api_python.act.get_delegation_chain\"><code class=\"xref py py-obj docutils literal notranslate\"><span class=\"pre\">get_delegation_chain</span></code></a>(\u2192\u00a0list[str])</p></td>\n<td><p>Return the delegation chain from newest actor to oldest actor.</p></td>\n</tr>\n</tbody>\n</table>\n</section>\n<section id=\"module-contents\">\n<h2>Module Contents<a class=\"headerlink\" href=\"#module-contents\" title=\"Link to this heading\">\u00b6</a></h2>\n<dl class=\"py data\">\n<dt class=\"sig sig-object py\" id=\"auth0_api_python.act.INVALID_ACT_CLAIM_MESSAGE\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">auth0_api_python.act.</span></span><span class=\"sig-name descname\"><span class=\"pre\">INVALID_ACT_CLAIM_MESSAGE</span></span><em class=\"property\"><span class=\"w\"> </span><span class=\"p\"><span class=\"pre\">=</span></span><span class=\"w\"> </span><span class=\"pre\">'Invalid</span> <span class=\"pre\">act</span> <span class=\"pre\">claim'</span></em><a class=\"headerlink\" href=\"#auth0_api_python.act.INVALID_ACT_CLAIM_MESSAGE\" title=\"Link to this definition\">\u00b6</a></dt>\n<dd></dd></dl>\n\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"auth0_api_python.act.get_current_actor\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">auth0_api_python.act.</span></span><span class=\"sig-name descname\"><span class=\"pre\">get_current_actor</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">claims</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">collections.abc.Mapping</span><span class=\"p\"><span class=\"pre\">[</span></span><span class=\"pre\">str</span><span class=\"p\"><span class=\"pre\">,</span></span><span class=\"w\"> </span><span class=\"pre\">Any</span><span class=\"p\"><span class=\"pre\">]</span></span></span></em><span class=\"sig-paren\">)</span> <span class=\"sig-return\"><span class=\"sig-return-icon\">&#x2192;</span> <span class=\"sig-return-typehint\"><span class=\"pre\">str</span><span class=\"w\"> </span><span class=\"p\"><span class=\"pre\">|</span></span><span class=\"w\"> </span><span class=\"pre\">None</span></span></span><a class=\"headerlink\" href=\"#auth0_api_python.act.get_current_actor\" title=\"Link to this definition\">\u00b6</a></dt>\n<dd><p>Return the current actor from the outermost <cite>act.sub</cite>, if present.</p>\n<p>Only the outermost <cite>act.sub</cite> should be used for authorization decisions.\nNested <cite>act</cite> values represent prior actors and are informational.</p>\n</dd></dl>\n\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"auth0_api_python.act.get_delegation_chain\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">auth0_api_python.act.</span></span><span class=\"sig-name descname\"><span class=\"pre\">get_delegation_chain</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">claims</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">collections.abc.Mapping</span><span class=\"p\"><span class=\"pre\">[</span></span><span class=\"pre\">str</span><span class=\"p\"><span class=\"pre\">,</span></span><span class=\"w\"> </span><span class=\"pre\">Any</span><span class=\"p\"><span class=\"pre\">]</span></span></span></em><span class=\"sig-paren\">)</span> <span class=\"sig-return\"><span class=\"sig-return-icon\">&#x2192;</span> <span class=\"sig-return-typehint\"><span class=\"pre\">list</span><span class=\"p\"><span class=\"pre\">[</span></span><span class=\"pre\">str</span><span class=\"p\"><span class=\"pre\">]</span></span></span></span><a class=\"headerlink\" href=\"#auth0_api_python.act.get_delegation_chain\" title=\"Link to this definition\">\u00b6</a></dt>\n<dd><p>Return the delegation chain from newest actor to oldest actor.</p>\n<p>The first entry is the current actor (outermost <cite>act.sub</cite>). Later entries are\nprior actors from nested <cite>act</cite> values and are typically most useful for audit\nand attribution.</p>\n</dd></dl>\n\n</section>\n</section>\n", "metatags": "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n", "rellinks": [["genindex", "General Index", "I", "index"], ["py-modindex", "Python Module Index", "", "modules"], ["auth0_api_python/api_client/index", "auth0_api_python.api_client", "N", "next"], ["index", "auth0-api-python", "P", "previous"]], "sourcename": "auth0_api_python/act/index.rst.txt", "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">auth0_api_python.act</a><ul>\n<li><a class=\"reference internal\" href=\"#attributes\">Attributes</a></li>\n<li><a class=\"reference internal\" href=\"#functions\">Functions</a></li>\n<li><a class=\"reference internal\" href=\"#module-contents\">Module Contents</a><ul>\n<li><a class=\"reference internal\" href=\"#auth0_api_python.act.INVALID_ACT_CLAIM_MESSAGE\"><code class=\"docutils literal notranslate\"><span class=\"pre\">INVALID_ACT_CLAIM_MESSAGE</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#auth0_api_python.act.get_current_actor\"><code class=\"docutils literal notranslate\"><span class=\"pre\">get_current_actor()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#auth0_api_python.act.get_delegation_chain\"><code class=\"docutils literal notranslate\"><span class=\"pre\">get_delegation_chain()</span></code></a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n", "display_toc": true, "page_source_suffix": ".rst", "current_page_name": "auth0_api_python/act/index", "sidebars": ["about.html", "searchfield.html", "navigation.html", "relations.html", "donate.html"], "alabaster_version": "1.0.0", "alabaster_version_info": [1, 0, 0]}

‎sphinx/json/auth0_api_python/api_client/index.fjson‎

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

‎sphinx/json/auth0_api_python/cache/index.fjson‎

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

‎sphinx/json/auth0_api_python/config/index.fjson‎

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"parents": [], "prev": {"link": "../config/", "title": "auth0_api_python.config"}, "next": {"link": "../errors/", "title": "auth0_api_python.errors"}, "title": "auth0_api_python.encryption", "meta": null, "body": "<section id=\"module-auth0_api_python.encryption\">\n<span id=\"auth0-api-python-encryption\"></span><h1>auth0_api_python.encryption<a class=\"headerlink\" href=\"#module-auth0_api_python.encryption\" title=\"Link to this heading\">\u00b6</a></h1>\n<p>JWE encryption helpers for token store implementations.</p>\n<section id=\"functions\">\n<h2>Functions<a class=\"headerlink\" href=\"#functions\" title=\"Link to this heading\">\u00b6</a></h2>\n<table class=\"autosummary longtable docutils align-default\">\n<tbody>\n<tr class=\"row-odd\"><td><p><a class=\"reference internal\" href=\"#auth0_api_python.encryption.encrypt\" title=\"auth0_api_python.encryption.encrypt\"><code class=\"xref py py-obj docutils literal notranslate\"><span class=\"pre\">encrypt</span></code></a>(\u2192\u00a0str)</p></td>\n<td><p>Encrypt a dict to a compact JWE string. A fresh random kid is generated per call.</p></td>\n</tr>\n<tr class=\"row-even\"><td><p><a class=\"reference internal\" href=\"#auth0_api_python.encryption.decrypt\" title=\"auth0_api_python.encryption.decrypt\"><code class=\"xref py py-obj docutils literal notranslate\"><span class=\"pre\">decrypt</span></code></a>(\u2192\u00a0dict[str,\u00a0Any])</p></td>\n<td><p>Decrypt a compact JWE string back to a dict.</p></td>\n</tr>\n</tbody>\n</table>\n</section>\n<section id=\"module-contents\">\n<h2>Module Contents<a class=\"headerlink\" href=\"#module-contents\" title=\"Link to this heading\">\u00b6</a></h2>\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"auth0_api_python.encryption.encrypt\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">auth0_api_python.encryption.</span></span><span class=\"sig-name descname\"><span class=\"pre\">encrypt</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">payload</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">dict</span><span class=\"p\"><span class=\"pre\">[</span></span><span class=\"pre\">str</span><span class=\"p\"><span class=\"pre\">,</span></span><span class=\"w\"> </span><span class=\"pre\">Any</span><span class=\"p\"><span class=\"pre\">]</span></span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">secret</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">salt</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em><span class=\"sig-paren\">)</span> <span class=\"sig-return\"><span class=\"sig-return-icon\">&#x2192;</span> <span class=\"sig-return-typehint\"><span class=\"pre\">str</span></span></span><a class=\"headerlink\" href=\"#auth0_api_python.encryption.encrypt\" title=\"Link to this definition\">\u00b6</a></dt>\n<dd><p>Encrypt a dict to a compact JWE string. A fresh random kid is generated per call.</p>\n</dd></dl>\n\n<dl class=\"py function\">\n<dt class=\"sig sig-object py\" id=\"auth0_api_python.encryption.decrypt\">\n<span class=\"sig-prename descclassname\"><span class=\"pre\">auth0_api_python.encryption.</span></span><span class=\"sig-name descname\"><span class=\"pre\">decrypt</span></span><span class=\"sig-paren\">(</span><em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">data</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">secret</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em>, <em class=\"sig-param\"><span class=\"n\"><span class=\"pre\">salt</span></span><span class=\"p\"><span class=\"pre\">:</span></span><span class=\"w\"> </span><span class=\"n\"><span class=\"pre\">str</span></span></em><span class=\"sig-paren\">)</span> <span class=\"sig-return\"><span class=\"sig-return-icon\">&#x2192;</span> <span class=\"sig-return-typehint\"><span class=\"pre\">dict</span><span class=\"p\"><span class=\"pre\">[</span></span><span class=\"pre\">str</span><span class=\"p\"><span class=\"pre\">,</span></span><span class=\"w\"> </span><span class=\"pre\">Any</span><span class=\"p\"><span class=\"pre\">]</span></span></span></span><a class=\"headerlink\" href=\"#auth0_api_python.encryption.decrypt\" title=\"Link to this definition\">\u00b6</a></dt>\n<dd><p>Decrypt a compact JWE string back to a dict.</p>\n</dd></dl>\n\n</section>\n</section>\n", "metatags": "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n", "rellinks": [["genindex", "General Index", "I", "index"], ["py-modindex", "Python Module Index", "", "modules"], ["auth0_api_python/errors/index", "auth0_api_python.errors", "N", "next"], ["auth0_api_python/config/index", "auth0_api_python.config", "P", "previous"]], "sourcename": "auth0_api_python/encryption/index.rst.txt", "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">auth0_api_python.encryption</a><ul>\n<li><a class=\"reference internal\" href=\"#functions\">Functions</a></li>\n<li><a class=\"reference internal\" href=\"#module-contents\">Module Contents</a><ul>\n<li><a class=\"reference internal\" href=\"#auth0_api_python.encryption.encrypt\"><code class=\"docutils literal notranslate\"><span class=\"pre\">encrypt()</span></code></a></li>\n<li><a class=\"reference internal\" href=\"#auth0_api_python.encryption.decrypt\"><code class=\"docutils literal notranslate\"><span class=\"pre\">decrypt()</span></code></a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n", "display_toc": true, "page_source_suffix": ".rst", "current_page_name": "auth0_api_python/encryption/index", "sidebars": ["about.html", "searchfield.html", "navigation.html", "relations.html", "donate.html"], "alabaster_version": "1.0.0", "alabaster_version_info": [1, 0, 0]}

‎sphinx/json/auth0_api_python/errors/index.fjson‎

Lines changed: 1 addition & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)