pdoc 13.0.1__py3-none-any.whl → 13.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. pdoc/__init__.py +9 -1
  2. pdoc/__main__.py +7 -0
  3. pdoc/_compat.py +5 -2
  4. pdoc/doc.py +33 -4
  5. pdoc/doc_ast.py +10 -6
  6. pdoc/markdown2/__init__.py +371 -253
  7. pdoc/render.py +3 -0
  8. pdoc/render_helpers.py +1 -0
  9. pdoc/templates/default/frame.html.jinja2 +1 -0
  10. pdoc/templates/mermaid.html.jinja2 +18 -0
  11. {pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/METADATA +1 -1
  12. {pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/RECORD +16 -15
  13. {pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/WHEEL +1 -1
  14. {pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/LICENSE +0 -0
  15. {pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/entry_points.txt +0 -0
  16. {pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/top_level.txt +0 -0
pdoc/render.py CHANGED
@@ -40,6 +40,7 @@ def configure(
40
40
  logo: str | None = None,
41
41
  logo_link: str | None = None,
42
42
  math: bool = False,
43
+ mermaid: bool = False,
43
44
  search: bool = True,
44
45
  show_source: bool = True,
45
46
  template_directory: Path | None = None,
@@ -61,6 +62,7 @@ def configure(
61
62
  - `logo` is an optional URL to the project's logo image
62
63
  - `logo_link` is an optional URL the logo should point to
63
64
  - `math` enables math rendering by including MathJax into the rendered documentation.
65
+ - `mermaid` enables diagram rendering by including Mermaid.js into the rendered documentation.
64
66
  - `search` controls whether search functionality is enabled and a search index is built.
65
67
  - `show_source` controls whether a "View Source" button should be included in the output.
66
68
  - `template_directory` can be used to set an additional (preferred) directory
@@ -75,6 +77,7 @@ def configure(
75
77
  env.globals["edit_url_map"] = edit_url_map or {}
76
78
  env.globals["docformat"] = docformat
77
79
  env.globals["math"] = math
80
+ env.globals["mermaid"] = mermaid
78
81
  env.globals["show_source"] = show_source
79
82
  env.globals["favicon"] = favicon
80
83
  env.globals["logo"] = logo
pdoc/render_helpers.py CHANGED
@@ -63,6 +63,7 @@ markdown_extensions = {
63
63
  "header-ids": None,
64
64
  "link-patterns": None,
65
65
  "markdown-in-html": None,
66
+ "mermaid": None,
66
67
  "pyshell": None,
67
68
  "strike": None,
68
69
  "tables": None,
pdoc/templates/default/frame.html.jinja2 CHANGED
@@ -30,6 +30,7 @@
30
30
  {% endblock %}
31
31
  {% endfilter %}
32
32
  {% if math %}{% include "math.html.jinja2" %}{% endif %}
33
+ {% if mermaid %}{% include "mermaid.html.jinja2" %}{% endif %}
33
34
  </head>
34
35
  <body>
35
36
  {% block body %}
pdoc/templates/mermaid.html.jinja2 ADDED
@@ -0,0 +1,18 @@
1
+ {# This template is included in mermaid mode and loads Mermaid.js for formula rendering. #}
2
+ <style>
3
+ .pdoc .mermaid-pre {
4
+ border: none;
5
+ background: none;
6
+ }
7
+ </style>
8
+ <script type="module" defer>
9
+ import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
10
+
11
+ /* Re-invoke Mermaid when DOM content changes, for example during search. */
12
+ document.addEventListener("DOMContentLoaded", () => {
13
+ new MutationObserver(() => mermaid.run()).observe(
14
+ document.querySelector("main.pdoc").parentNode,
15
+ {childList: true}
16
+ );
17
+ })
18
+ </script>
{pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: pdoc
3
- Version: 13.0.1
3
+ Version: 13.1.1
4
4
  Summary: API Documentation for Python Projects
5
5
  Author-email: Maximilian Hils <pdoc@maximilianhils.com>
6
6
  License: Unlicense
{pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/RECORD RENAMED
@@ -1,20 +1,20 @@
1
- pdoc/__init__.py,sha256=1ELWgB8TNS_CIZnte_RqmF3PiofNjycuEjVCajb2WKE,20283
2
- pdoc/__main__.py,sha256=lOkJSrKEf5dREiVF8U-pG5i_3MEetLzd9S3x_aA6LuQ,7937
3
- pdoc/_compat.py,sha256=X24QKwuCY5uEwBfUArjF6VCUxhUU-jbpcCF-MMPFtR0,6580
4
- pdoc/doc.py,sha256=K32KrEZwDhFwZX1eNk8RIAI85B55KDtJAQoOJ07Q84M,45107
5
- pdoc/doc_ast.py,sha256=MApShMaptHM3X8gPytChwVH7k-Dbmn7MmiEkjWEr2zg,11251
1
+ pdoc/__init__.py,sha256=Eh9uzOm_jpCBAXvv9rPq4O8MjEkdP9yOhAHO24UfFHs,20675
2
+ pdoc/__main__.py,sha256=hJdWc6prjnT6ZJ5hxtcGbW2qwP6Hu8vyubEmZPGfBPI,8143
3
+ pdoc/_compat.py,sha256=l932AKYOWCfYO38XIi6tGT84uV7DDa9CfY6NMF5dNJQ,6667
4
+ pdoc/doc.py,sha256=P5vKveKFOkcWu0N-Jn-JlsgpgSEwppRU02sGPn-UjWo,46160
5
+ pdoc/doc_ast.py,sha256=8DrZ4g0_yXnr0FBvRwCj8ovuijVQfbgvkqLiZms1SB4,11419
6
6
  pdoc/doc_pyi.py,sha256=kVFNTgdq3BZzqaQ8Pp0QMCDTg4WqjSe5dPGeDksDGhE,4059
7
7
  pdoc/doc_types.py,sha256=9BcRcdJxb6RJURYcHfqa0kyS0TwnZvi6kIGBr6Mdo_g,7472
8
8
  pdoc/docstrings.py,sha256=6oCpIS3o3rmXclLr-niUwn5cFzZp59C4t5AwQ8iZ8kQ,14893
9
9
  pdoc/extract.py,sha256=JKTUNBNKIGmLSZgcZlxh7BD6i_Xq1_UE7djDCp0bthE,12771
10
10
  pdoc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
11
- pdoc/render.py,sha256=JoNn4SYUXntUmc5lMbfrHEuTS0kYoK2ORkj58qHgi1M,6693
12
- pdoc/render_helpers.py,sha256=9utsDQwtZGk1RWvEnHAT4-Cu7KryiOjRGPqxnMRNrpU,17311
11
+ pdoc/render.py,sha256=cNswrALbDDcvKFXfI9eFAtEUB8t_q-Q8qkfNC_Wy5kQ,6856
12
+ pdoc/render_helpers.py,sha256=W6KZzkWFqw8FsMB-NSl6ymj9w1Jbp57agLVqW4Fi9qk,17332
13
13
  pdoc/search.py,sha256=jmE7q5ZMGR0hAeu_yEme9mS3hs48vW5Va5AlPWS0kUA,7031
14
14
  pdoc/web.py,sha256=kmv3rww72jwra64DwWftsXODu8sLPtI0AVJV_UT6nIM,6400
15
15
  pdoc/markdown2/LICENSE,sha256=BfcOT5Iu-7wDaKcbIta8wkP-pFncOu4yXeBlMfbeYGI,1116
16
16
  pdoc/markdown2/README.md,sha256=-b2NGwLPzTBnaCGPSqRCzHxSrqArlXxGG5w0c6pOqFk,200
17
- pdoc/markdown2/__init__.py,sha256=DIkOBIrUzTb2t9I152Ak-AuRz6KaxVMb8llTw9y3o7A,122785
17
+ pdoc/markdown2/__init__.py,sha256=d12k9Kr2TnRRz0ga_VH73R5QkW2UjGO_wDzSR6kFJpI,127882
18
18
  pdoc/templates/README.md,sha256=ukxrGoYYCIYkScS5j2Dge8c3VEd01AzOiIKq6yl5OqE,1780
19
19
  pdoc/templates/build-search-index.js,sha256=igiRW84j_aRFmGv5j48e8gnWeTgfdL8Rs930vHOUYyU,982
20
20
  pdoc/templates/content.css,sha256=dkNk-K3Ju8Xq93SVRc95mHSZT_zg9KvHg1yvyKwOueU,9192
@@ -22,12 +22,13 @@ pdoc/templates/custom.css,sha256=62cn8AmBJiplFJyAKXoZSlVa1s3lNOjkYwDp20pF-ew,106
22
22
  pdoc/templates/layout.css,sha256=G-lchsFWYmkeGGpxxDdAQ3T3kBGoOAYyxY7ZuiVliwA,4654
23
23
  pdoc/templates/livereload.html.jinja2,sha256=VHbZWN_dBRgBpaRzszvXbbX278-fzbok0JRIOeLep_E,566
24
24
  pdoc/templates/math.html.jinja2,sha256=tw7wpwGhQYUxU5SjjZxFsyk5gqaeMv_5IYFUb4hxqpY,1046
25
+ pdoc/templates/mermaid.html.jinja2,sha256=cZSmk1Zmec2HaziyEiz2jgmjzQmrG-ZhQISGrhXa1Qc,625
25
26
  pdoc/templates/search.html.jinja2,sha256=6mfYR7S8bI7aprnZFCNvusnji5Zj-QpufaCjSMUQ3Bc,7497
26
27
  pdoc/templates/search.js.jinja2,sha256=pRH-19e80c7Nlu9cKckse4RRruRoYjyiDZscZ3nIdbs,1773
27
28
  pdoc/templates/syntax-highlighting.css,sha256=h8SkYVmzf9s4bZiHDPQPytCBuJCeIOK2Kj17V7fmcjM,4545
28
29
  pdoc/templates/theme.css,sha256=yjnbtPVmqaifTINsA5sK2a3e1aoFO0UlOMgOSKUgLvI,397
29
30
  pdoc/templates/default/error.html.jinja2,sha256=RqH14o6ZV79uBO14gKSjwObXFKKczkcLTMe1orurEJk,970
30
- pdoc/templates/default/frame.html.jinja2,sha256=MLsl-x9EU9RTnQ3Z5BopgdVnrWYiPeBXTJYmQZn6jAo,2097
31
+ pdoc/templates/default/frame.html.jinja2,sha256=Qp5zlts8Bl-O2f0cxJHH_QdmAkMtJJjNVA0ZU2Mbwl8,2164
31
32
  pdoc/templates/default/index.html.jinja2,sha256=MkzVYMWUuJgscty3jVbDtcEfB1vz-bp3v_sMa5MzevU,2381
32
33
  pdoc/templates/default/module.html.jinja2,sha256=QAK6pRMF1ip4hwYCK6LyMuDF7EmbGwc8h9eDN9JsWUw,12689
33
34
  pdoc/templates/deprecated/README.md,sha256=8HPj4Bu6EPAdHbH5CQVYgcD580zpkhqbwiSFoLAVB1Q,339
@@ -46,9 +47,9 @@ pdoc/templates/resources/info-circle-fill.svg,sha256=kO3AMXfWtacpJPzC8Pvihf46OZd
46
47
  pdoc/templates/resources/lightning-fill.svg,sha256=XEyCtbgxeAlwCezdsf7N0NFd5aMjwqyJJDpaFbYYTFA,265
47
48
  pdoc/templates/resources/navtoggle.svg,sha256=WVR0BJIucX0MgwwEawmfX0qYD1i_dSbUhoGnqPef3jw,187
48
49
  pdoc/templates/resources/pdoc-logo.svg,sha256=w5OsMmytDaA2Fr9CobeQQFxBNx4-wFFHtLvkORj0gjk,6989
49
- pdoc-13.0.1.dist-info/LICENSE,sha256=fhLl30uuEsshWBuhV87SDhmGoFCN0Q0Oikq5pM-U6Fw,1211
50
- pdoc-13.0.1.dist-info/METADATA,sha256=hRPVR3UIttsIivl-7VmT1mJykOVLgP0NMtCr5UaFK6g,7425
51
- pdoc-13.0.1.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
52
- pdoc-13.0.1.dist-info/entry_points.txt,sha256=-bK-S1ZvmqCWqi1hGnsl5nayWkzXB1BEs-Cynh5QZaI,43
53
- pdoc-13.0.1.dist-info/top_level.txt,sha256=rg5eIToBHzwTfZZi1E7NVHgie5joQuSuU1rWV0qKS9k,5
54
- pdoc-13.0.1.dist-info/RECORD,,
50
+ pdoc-13.1.1.dist-info/LICENSE,sha256=fhLl30uuEsshWBuhV87SDhmGoFCN0Q0Oikq5pM-U6Fw,1211
51
+ pdoc-13.1.1.dist-info/METADATA,sha256=82SNtlXsPl0WLsZtkxNQE8pHJHFGC6VINASjhK0lF3w,7425
52
+ pdoc-13.1.1.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
53
+ pdoc-13.1.1.dist-info/entry_points.txt,sha256=-bK-S1ZvmqCWqi1hGnsl5nayWkzXB1BEs-Cynh5QZaI,43
54
+ pdoc-13.1.1.dist-info/top_level.txt,sha256=rg5eIToBHzwTfZZi1E7NVHgie5joQuSuU1rWV0qKS9k,5
55
+ pdoc-13.1.1.dist-info/RECORD,,
{pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/WHEEL RENAMED
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: bdist_wheel (0.38.4)
2
+ Generator: bdist_wheel (0.40.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
{pdoc-13.0.1.dist-info → pdoc-13.1.1.dist-info}/LICENSE RENAMED
File without changes