mkdocstrings-typescript 0.1.0__tar.gz → 0.1.1__tar.gz

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 (102) hide show
  1. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/CHANGELOG.md +12 -0
  2. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/PKG-INFO +9 -5
  3. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/README.md +6 -1
  4. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/config/pytest.ini +2 -0
  5. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/config/ruff.toml +1 -1
  6. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/.overrides/main.html +5 -7
  7. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/usage/configuration/headings.md +0 -4
  8. mkdocstrings_typescript-0.1.1/docs/usage/customization.md +198 -0
  9. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/duties.py +25 -93
  10. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/mkdocs.yml +8 -16
  11. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/pyproject.toml +3 -5
  12. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/scripts/gen_credits.py +3 -10
  13. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/scripts/get_version.py +6 -1
  14. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/scripts/make.py +48 -13
  15. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/_internal/config.py +5 -35
  16. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/_internal/debug.py +1 -1
  17. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/_internal/handler.py +1 -1
  18. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/style.css +0 -13
  19. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/tests/test_api.py +4 -2
  20. mkdocstrings_typescript-0.1.0/docs/css/insiders.css +0 -124
  21. mkdocstrings_typescript-0.1.0/docs/insiders/changelog.md +0 -7
  22. mkdocstrings_typescript-0.1.0/docs/insiders/goals.yml +0 -16
  23. mkdocstrings_typescript-0.1.0/docs/insiders/index.md +0 -160
  24. mkdocstrings_typescript-0.1.0/docs/insiders/installation.md +0 -67
  25. mkdocstrings_typescript-0.1.0/docs/js/insiders.js +0 -74
  26. mkdocstrings_typescript-0.1.0/docs/usage/customization.md +0 -202
  27. mkdocstrings_typescript-0.1.0/scripts/insiders.py +0 -173
  28. mkdocstrings_typescript-0.1.0/src/mkdocstrings_handlers/typescript/templates/material/_base/data.html.jinja +0 -60
  29. mkdocstrings_typescript-0.1.0/src/mkdocstrings_handlers/typescript/templates/material/data.html.jinja +0 -1
  30. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/CODE_OF_CONDUCT.md +0 -0
  31. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/CONTRIBUTING.md +0 -0
  32. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/LICENSE +0 -0
  33. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/config/coverage.ini +0 -0
  34. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/config/git-changelog.toml +0 -0
  35. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/config/mypy.ini +0 -0
  36. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/config/vscode/launch.json +0 -0
  37. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/config/vscode/settings.json +0 -0
  38. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/config/vscode/tasks.json +0 -0
  39. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/.overrides/partials/comments.html +0 -0
  40. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/.overrides/partials/path-item.html +0 -0
  41. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/changelog.md +0 -0
  42. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/code_of_conduct.md +0 -0
  43. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/contributing.md +0 -0
  44. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/credits.md +0 -0
  45. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/css/material.css +0 -0
  46. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/css/mkdocstrings.css +0 -0
  47. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/index.md +0 -0
  48. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/js/feedback.js +0 -0
  49. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/license.md +0 -0
  50. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/reference/api.md +0 -0
  51. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/usage/configuration/general.md +0 -0
  52. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/usage/configuration/index.md +0 -0
  53. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/docs/usage/index.md +0 -0
  54. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/scripts/griffe_extensions.py +0 -0
  55. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/scripts/make +0 -0
  56. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/scripts/mkdocs_hooks.py +0 -0
  57. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/__init__.py +0 -0
  58. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/_internal/__init__.py +0 -0
  59. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/py.typed +0 -0
  60. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/accessor.html.jinja +0 -0
  61. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/call_signature.html.jinja +0 -0
  62. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/children.html.jinja +0 -0
  63. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/class.html.jinja +0 -0
  64. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/constructor.html.jinja +0 -0
  65. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/constructor_signature.html.jinja +0 -0
  66. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/dispatch.html.jinja +0 -0
  67. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/enum.html.jinja +0 -0
  68. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/enum_member.html.jinja +0 -0
  69. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/function.html.jinja +0 -0
  70. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/interface.html.jinja +0 -0
  71. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/method.html.jinja +0 -0
  72. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/module.html.jinja +0 -0
  73. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/namespace.html.jinja +0 -0
  74. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/project.html.jinja +0 -0
  75. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/property.html.jinja +0 -0
  76. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/reference.html.jinja +0 -0
  77. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/type.html.jinja +0 -0
  78. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/type_alias.html.jinja +0 -0
  79. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/_base/variable.html.jinja +0 -0
  80. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/accessor.html.jinja +0 -0
  81. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/call_signature.html.jinja +0 -0
  82. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/children.html.jinja +0 -0
  83. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/class.html.jinja +0 -0
  84. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/constructor.html.jinja +0 -0
  85. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/constructor_signature.html.jinja +0 -0
  86. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/dispatch.html.jinja +0 -0
  87. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/enum.html.jinja +0 -0
  88. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/enum_member.html.jinja +0 -0
  89. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/function.html.jinja +0 -0
  90. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/interface.html.jinja +0 -0
  91. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/method.html.jinja +0 -0
  92. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/module.html.jinja +0 -0
  93. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/namespace.html.jinja +0 -0
  94. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/project.html.jinja +0 -0
  95. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/property.html.jinja +0 -0
  96. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/reference.html.jinja +0 -0
  97. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/type.html.jinja +0 -0
  98. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/type_alias.html.jinja +0 -0
  99. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/src/mkdocstrings_handlers/typescript/templates/material/variable.html.jinja +0 -0
  100. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/tests/__init__.py +0 -0
  101. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/tests/conftest.py +0 -0
  102. {mkdocstrings_typescript-0.1.0 → mkdocstrings_typescript-0.1.1}/tests/test_themes.py +0 -0
@@ -6,6 +6,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
6
6
  and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
7
7
 
8
8
  <!-- insertion marker -->
9
+ ## [0.1.1](https://github.com/mkdocstrings/typescript/releases/tag/0.1.1) - 2026-10-06
10
+
11
+ <small>[Compare with 0.1.0](https://github.com/mkdocstrings/typescript/compare/0.1.0...0.1.1)</small>
12
+
13
+ ### Build
14
+
15
+ - Drop support for Python 3.10 ([29d2588](https://github.com/mkdocstrings/typescript/commit/29d2588839d3cce5f6a28c82d92df4949166cdb9) by Timothée Mazzucotelli).
16
+
17
+ ### Code Refactoring
18
+
19
+ - Remove `data` symbol type (coming from template) ([9688535](https://github.com/mkdocstrings/typescript/commit/9688535c0d25d77394cd347ce087a7aed55974a3) by Timothée Mazzucotelli).
20
+
9
21
  ## [0.1.0](https://github.com/mkdocstrings/typescript/releases/tag/0.1.0) - 2025-03-24
10
22
 
11
23
  <small>[Compare with 0.0.1](https://github.com/mkdocstrings/typescript/compare/0.0.1...0.1.0)</small>
@@ -1,8 +1,8 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-typescript
3
- Version: 0.1.0
3
+ Version: 0.1.1
4
4
  Summary: A Typescript handler for mkdocstrings.
5
- Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
5
+ Author-Email: Timothée Mazzucotelli <dev@pawamoy.fr>
6
6
  License-Expression: ISC
7
7
  License-File: LICENSE
8
8
  Classifier: Development Status :: 4 - Beta
@@ -10,7 +10,6 @@ Classifier: Intended Audience :: Developers
10
10
  Classifier: Programming Language :: Python
11
11
  Classifier: Programming Language :: Python :: 3
12
12
  Classifier: Programming Language :: Python :: 3 :: Only
13
- Classifier: Programming Language :: Python :: 3.10
14
13
  Classifier: Programming Language :: Python :: 3.11
15
14
  Classifier: Programming Language :: Python :: 3.12
16
15
  Classifier: Programming Language :: Python :: 3.13
@@ -27,7 +26,7 @@ Project-URL: Issues, https://github.com/mkdocstrings/typescript/issues
27
26
  Project-URL: Discussions, https://github.com/mkdocstrings/typescript/discussions
28
27
  Project-URL: Gitter, https://gitter.im/mkdocstrings/typescript
29
28
  Project-URL: Funding, https://github.com/sponsors/pawamoy
30
- Requires-Python: >=3.10
29
+ Requires-Python: >=3.11
31
30
  Requires-Dist: mkdocstrings>=0.28.3
32
31
  Requires-Dist: griffe-typedoc>=0.1
33
32
  Description-Content-Type: text/markdown
@@ -37,7 +36,7 @@ Description-Content-Type: text/markdown
37
36
  [![ci](https://github.com/mkdocstrings/typescript/workflows/ci/badge.svg)](https://github.com/mkdocstrings/typescript/actions?query=workflow%3Aci)
38
37
  [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/typescript/)
39
38
  [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-typescript.svg)](https://pypi.org/project/mkdocstrings-typescript/)
40
- [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#typescript:gitter.im)
39
+ [![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#typescript:gitter.im)
41
40
 
42
41
  A Typescript handler for mkdocstrings.
43
42
 
@@ -122,3 +121,8 @@ By setting it as default handler you can omit it when injecting documentation:
122
121
  ```md
123
122
  ::: @owner/packageName
124
123
  ```
124
+
125
+ ## Sponsors
126
+
127
+ <!-- sponsors-start -->
128
+ <!-- sponsors-end -->
@@ -3,7 +3,7 @@
3
3
  [![ci](https://github.com/mkdocstrings/typescript/workflows/ci/badge.svg)](https://github.com/mkdocstrings/typescript/actions?query=workflow%3Aci)
4
4
  [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/typescript/)
5
5
  [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-typescript.svg)](https://pypi.org/project/mkdocstrings-typescript/)
6
- [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#typescript:gitter.im)
6
+ [![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#typescript:gitter.im)
7
7
 
8
8
  A Typescript handler for mkdocstrings.
9
9
 
@@ -88,3 +88,8 @@ By setting it as default handler you can omit it when injecting documentation:
88
88
  ```md
89
89
  ::: @owner/packageName
90
90
  ```
91
+
92
+ ## Sponsors
93
+
94
+ <!-- sponsors-start -->
95
+ <!-- sponsors-end -->
@@ -10,5 +10,7 @@ testpaths =
10
10
  # action:message_regex:warning_class:module_regex:line
11
11
  filterwarnings =
12
12
  error
13
+ default::EncodingWarning
14
+ error::EncodingWarning:typescript
13
15
  # TODO: remove once pytest-xdist 4 is released
14
16
  ignore:.*rsyncdir:DeprecationWarning:xdist
@@ -1,4 +1,4 @@
1
- target-version = "py39"
1
+ target-version = "py311"
2
2
  line-length = 120
3
3
 
4
4
  [lint]
@@ -1,13 +1,11 @@
1
1
  {% extends "base.html" %}
2
2
 
3
3
  {% block announce %}
4
-
5
- <strong>Fund this project</strong> through
6
- <a href="{{ 'insiders/#how-to-become-a-sponsor' | url }}"><strong>sponsorship</strong></a>
7
- <span class="twemoji heart pulse">
8
- {% include ".icons/octicons/heart-fill-16.svg" %}
9
- </span> &mdash;
10
-
4
+ <strong>Fund this project</strong> through
5
+ <a href="https://github.com/sponsors/pawamoy"><strong>sponsorship</strong></a>
6
+ <span class="twemoji heart pulse">
7
+ {% include ".icons/octicons/heart-fill-16.svg" %}
8
+ </span> &mdash;
11
9
  Follow
12
10
  <strong>@pawamoy</strong> on
13
11
  <a rel="me" href="https://fosstodon.org/@pawamoy">
@@ -83,7 +83,6 @@ This option will prefix headings with
83
83
  <code class="doc-symbol doc-symbol-ts-attribute"></code>,
84
84
  <code class="doc-symbol doc-symbol-ts-class"></code>,
85
85
  <code class="doc-symbol doc-symbol-ts-constructor"></code>,
86
- <code class="doc-symbol doc-symbol-ts-data"></code>,
87
86
  <code class="doc-symbol doc-symbol-ts-enum"></code>,
88
87
  <code class="doc-symbol doc-symbol-ts-enum_member"></code>,
89
88
  <code class="doc-symbol doc-symbol-ts-interface"></code>,
@@ -124,7 +123,6 @@ plugins:
124
123
  <h2><code class="doc-symbol doc-symbol-ts-attribute"></code> <code>foo</code></h2><p>Docstring of the attribute.</p>
125
124
  <h2><code class="doc-symbol doc-symbol-ts-class"></code> <code>Foo</code></h2><p>Docstring of the class.</p>
126
125
  <h2><code class="doc-symbol doc-symbol-ts-constructor"></code> <code>foo</code></h2><p>Docstring of the constructor.</p>
127
- <h2><code class="doc-symbol doc-symbol-ts-data"></code> <code>foo</code></h2><p>Docstring of the data.</p>
128
126
  <h2><code class="doc-symbol doc-symbol-ts-enum"></code> <code>Foo</code></h2><p>Docstring of the enum.</p>
129
127
  <h2><code class="doc-symbol doc-symbol-ts-enum_member"></code> <code>foo</code></h2><p>Docstring of the enum member.</p>
130
128
  <h2><code class="doc-symbol doc-symbol-ts-interface"></code> <code>Foo</code></h2><p>Docstring of the interface.</p>
@@ -172,7 +170,6 @@ This option will prefix items in the ToC with
172
170
  <code class="doc-symbol doc-symbol-ts-attribute"></code>,
173
171
  <code class="doc-symbol doc-symbol-ts-class"></code>,
174
172
  <code class="doc-symbol doc-symbol-ts-constructor"></code>,
175
- <code class="doc-symbol doc-symbol-ts-data"></code>,
176
173
  <code class="doc-symbol doc-symbol-ts-enum"></code>,
177
174
  <code class="doc-symbol doc-symbol-ts-enum_member"></code>,
178
175
  <code class="doc-symbol doc-symbol-ts-interface"></code>,
@@ -214,7 +211,6 @@ plugins:
214
211
  <li><code class="doc-symbol doc-symbol-ts-attribute"></code> foo</li>
215
212
  <li><code class="doc-symbol doc-symbol-ts-class"></code> Foo</li>
216
213
  <li><code class="doc-symbol doc-symbol-ts-constructor"></code> foo</li>
217
- <li><code class="doc-symbol doc-symbol-ts-data"></code> foo</li>
218
214
  <li><code class="doc-symbol doc-symbol-ts-enum"></code> Foo</li>
219
215
  <li><code class="doc-symbol doc-symbol-ts-enum_member"></code> foo</li>
220
216
  <li><code class="doc-symbol doc-symbol-ts-interface"></code> Foo</li>
@@ -0,0 +1,198 @@
1
+ # Customization
2
+
3
+ It is possible to customize the output of the generated documentation with CSS and/or by overriding templates.
4
+
5
+ ## CSS classes
6
+
7
+ Our templates add [CSS](https://www.w3schools.com/Css/) classes to many HTML elements to make it possible for users to customize the resulting look and feel.
8
+
9
+ To add CSS rules and style mkdocstrings' output, put them in a CSS file in your docs folder, for example in `docs/css/mkdocstrings.css`, and reference this file in [MkDocs' `extra_css` configuration option](https://www.mkdocs.org/user-guide/configuration/#extra_css):
10
+
11
+ ```yaml title="mkdocs.yml"
12
+ extra_css:
13
+ - css/mkdocstrings.css
14
+ ```
15
+
16
+ Example:
17
+
18
+ ```css title="docs/css/mkdocstrings.css"
19
+ .doc-section-title {
20
+ font-weight: bold;
21
+ }
22
+ ```
23
+
24
+ ## Symbol types
25
+
26
+ ### Colors
27
+
28
+ You can customize the colors of the symbol types (see [`show_symbol_type_heading`][show_symbol_type_heading] and [`show_symbol_type_toc`][show_symbol_type_toc]) by overriding the values of our CSS variables, for example:
29
+
30
+ ```css title="docs/css/mkdocstrings.css"
31
+ [data-md-color-scheme="default"] {
32
+ --doc-symbol-ts-accessor-fg-color: #6f42c1;
33
+ --doc-symbol-ts-attribute-fg-color: #6f42c1;
34
+ --doc-symbol-ts-class-fg-color: #22863a;
35
+ --doc-symbol-ts-constructor-fg-color: #1f66ff;
36
+ --doc-symbol-ts-enum-fg-color: #6f42c1;
37
+ --doc-symbol-ts-enum_member-fg-color: #f0ad4e;
38
+ --doc-symbol-ts-interface-fg-color: #6f42c1;
39
+ --doc-symbol-ts-method-fg-color: #0366d6;
40
+ --doc-symbol-ts-module-fg-color: #0366d6;
41
+ --doc-symbol-ts-namespace-fg-color: #0366d6;
42
+ --doc-symbol-ts-parameter-fg-color: #e36209;
43
+ --doc-symbol-ts-project-fg-color: #24292f;
44
+ --doc-symbol-ts-property-fg-color: #6f42c1;
45
+ --doc-symbol-ts-type-fg-color: #6f42c1;
46
+ --doc-symbol-ts-type_alias-fg-color: #6f42c1;
47
+ --doc-symbol-ts-variable-fg-color: #e36209;
48
+
49
+ --doc-symbol-ts-accessor-bg-color: #6f42c11a;
50
+ --doc-symbol-ts-attribute-bg-color: #6f42c11a;
51
+ --doc-symbol-ts-class-bg-color: #22863a1a;
52
+ --doc-symbol-ts-constructor-bg-color: #1f66ff1a;
53
+ --doc-symbol-ts-enum-bg-color: #6f42c11a;
54
+ --doc-symbol-ts-enum_member-bg-color: #f0ad4e1a;
55
+ --doc-symbol-ts-interface-bg-color: #6f42c11a;
56
+ --doc-symbol-ts-method-bg-color: #0366d61a;
57
+ --doc-symbol-ts-module-bg-color: #0366d61a;
58
+ --doc-symbol-ts-namespace-bg-color: #0366d61a;
59
+ --doc-symbol-ts-parameter-bg-color: #e362091a;
60
+ --doc-symbol-ts-project-bg-color: #24292f1a;
61
+ --doc-symbol-ts-property-bg-color: #6f42c11a;
62
+ --doc-symbol-ts-type-bg-color: #6f42c11a;
63
+ --doc-symbol-ts-type_alias-bg-color: #6f42c11a;
64
+ --doc-symbol-ts-variable-bg-color: #e362091a;
65
+ }
66
+
67
+ [data-md-color-scheme="slate"] {
68
+ --doc-symbol-ts-accessor-fg-color: #d4a5f0;
69
+ --doc-symbol-ts-attribute-fg-color: #d4a5f0;
70
+ --doc-symbol-ts-class-fg-color: #78e7d1;
71
+ --doc-symbol-ts-constructor-fg-color: #6ba3ff;
72
+ --doc-symbol-ts-enum-fg-color: #d4a5f0;
73
+ --doc-symbol-ts-enum_member-fg-color: #ffb864;
74
+ --doc-symbol-ts-interface-fg-color: #d4a5f0;
75
+ --doc-symbol-ts-method-fg-color: #58a6ff;
76
+ --doc-symbol-ts-module-fg-color: #58a6ff;
77
+ --doc-symbol-ts-namespace-fg-color: #58a6ff;
78
+ --doc-symbol-ts-parameter-fg-color: #f4a261;
79
+ --doc-symbol-ts-project-fg-color: #e1e4e8;
80
+ --doc-symbol-ts-property-fg-color: #d4a5f0;
81
+ --doc-symbol-ts-type-fg-color: #d4a5f0;
82
+ --doc-symbol-ts-type_alias-fg-color: #d4a5f0;
83
+ --doc-symbol-ts-variable-fg-color: #f4a261;
84
+
85
+ --doc-symbol-ts-accessor-bg-color: #d4a5f01a;
86
+ --doc-symbol-ts-attribute-bg-color: #d4a5f01a;
87
+ --doc-symbol-ts-class-bg-color: #78e7d11a;
88
+ --doc-symbol-ts-constructor-bg-color: #6ba3ff1a;
89
+ --doc-symbol-ts-enum-bg-color: #d4a5f01a;
90
+ --doc-symbol-ts-enum_member-bg-color: #ffb8641a;
91
+ --doc-symbol-ts-interface-bg-color: #d4a5f01a;
92
+ --doc-symbol-ts-method-bg-color: #58a6ff1a;
93
+ --doc-symbol-ts-module-bg-color: #58a6ff1a;
94
+ --doc-symbol-ts-namespace-bg-color: #58a6ff1a;
95
+ --doc-symbol-ts-parameter-bg-color: #f4a2611a;
96
+ --doc-symbol-ts-project-bg-color: #e1e4e81a;
97
+ --doc-symbol-ts-property-bg-color: #d4a5f01a;
98
+ --doc-symbol-ts-type-bg-color: #d4a5f01a;
99
+ --doc-symbol-ts-type_alias-bg-color: #d4a5f01a;
100
+ --doc-symbol-ts-variable-bg-color: #f4a2611a;
101
+ }
102
+ ```
103
+
104
+ The `[data-md-color-scheme="*"]` selectors work with the [Material for MkDocs] theme. If you are using another theme, adapt the selectors to this theme if it supports light and dark themes, otherwise just override the variables at root level:
105
+
106
+ ```css title="docs/css/mkdocstrings.css"
107
+ :root {
108
+ --doc-symbol-ts-class-fg-color: #d1b619;
109
+ --doc-symbol-ts-class-bg-color: #d1b6191a;
110
+ }
111
+ ```
112
+
113
+ /// admonition | Preview
114
+ type: preview
115
+
116
+ <div id="preview-symbol-colors">
117
+ <style>
118
+ [data-md-color-scheme="default"] #preview-symbol-colors {
119
+ --doc-symbol-ts-class-fg-color: #d1b619;
120
+ --doc-symbol-ts-class-bg-color: #d1b6191a;
121
+ }
122
+
123
+ [data-md-color-scheme="slate"] #preview-symbol-colors {
124
+ --doc-symbol-ts-class-fg-color: #46c2cb;
125
+ --doc-symbol-ts-class-bg-color: #46c2cb1a;
126
+ }
127
+ </style>
128
+ <p>
129
+ Try cycling through the themes to see the colors for each theme:
130
+ <code class="doc-symbol doc-symbol-ts-class"></code
131
+ </p>
132
+ </div>
133
+
134
+ ///
135
+
136
+ ### Names
137
+
138
+ You can also change the actual symbol names. For example, to use single letters instead of truncated types:
139
+
140
+ ```css title="docs/css/mkdocstrings.css"
141
+ .doc-symbol-ts-class::after {
142
+ content: "C";
143
+ }
144
+ ```
145
+
146
+ /// admonition | Preview
147
+ type: preview
148
+
149
+ <div id="preview-symbol-names">
150
+ <style>
151
+ #preview-symbol-names .doc-symbol-ts-class::after {
152
+ content: "C";
153
+ }
154
+ </style>
155
+ <ul>
156
+ <li>Class: <code class="doc-symbol doc-symbol-ts-class"></code></li>
157
+ </ul>
158
+ </div>
159
+
160
+ ///
161
+
162
+ ## Templates
163
+
164
+ Templates are organized into the following tree:
165
+
166
+ ```python exec="1" result="tree"
167
+ from pathlib import Path
168
+
169
+ basedir = "src/mkdocstrings_handlers/typescript/templates/material"
170
+ print("theme/")
171
+ for filepath in sorted(path for path in Path(basedir).rglob("*") if "_base" not in str(path) and path.suffix != ".css"):
172
+ print(
173
+ " " * (len(filepath.relative_to(basedir).parent.parts) + 1)
174
+ + filepath.name
175
+ + ("/" if filepath.is_dir() else "")
176
+ )
177
+ ```
178
+
179
+ See them [in the repository](https://github.com/mkdocstrings/typescript/tree/main/src/mkdocstrings_handlers/typescript/templates/).
180
+ See the general *mkdocstrings* documentation to learn how to override them: https://mkdocstrings.github.io/theming/#templates.
181
+
182
+ Each one of these templates extends a base version in `theme/_base`. Example:
183
+
184
+ ```html+jinja title="theme/data.html.jinja"
185
+ {% extends "_base/data.html.jinja" %}
186
+ ```
187
+
188
+ Some of these templates define [Jinja blocks](https://jinja.palletsprojects.com/en/3.0.x/templates/#template-inheritance).
189
+ allowing to customize only *parts* of a template
190
+ without having to fully copy-paste it into your project:
191
+
192
+ ```jinja title="templates/theme/data.html"
193
+ {% extends "_base/data.html" %}
194
+ {% block contents scoped %}
195
+ {{ block.super }}
196
+ Additional contents
197
+ {% endblock contents %}
198
+ ```
@@ -5,17 +5,12 @@ from __future__ import annotations
5
5
  import os
6
6
  import re
7
7
  import sys
8
- from contextlib import contextmanager
9
- from functools import wraps
10
- from importlib.metadata import version as pkgversion
11
8
  from pathlib import Path
12
- from typing import TYPE_CHECKING, Any, Callable
9
+ from typing import TYPE_CHECKING
13
10
 
14
11
  from duty import duty, tools
15
12
 
16
13
  if TYPE_CHECKING:
17
- from collections.abc import Iterator
18
-
19
14
  from duty.context import Context
20
15
 
21
16
 
@@ -26,6 +21,8 @@ CI = os.environ.get("CI", "0") in {"1", "true", "yes", ""}
26
21
  WINDOWS = os.name == "nt"
27
22
  PTY = not WINDOWS and not CI
28
23
  MULTIRUN = os.environ.get("MULTIRUN", "0") == "1"
24
+ PY_VERSION = f"{sys.version_info.major}{sys.version_info.minor}"
25
+ PY_DEV = "314"
29
26
 
30
27
 
31
28
  def pyprefix(title: str) -> str:
@@ -35,33 +32,6 @@ def pyprefix(title: str) -> str:
35
32
  return title
36
33
 
37
34
 
38
- def not_from_insiders(func: Callable) -> Callable:
39
- @wraps(func)
40
- def wrapper(ctx: Context, *args: Any, **kwargs: Any) -> None:
41
- origin = ctx.run("git config --get remote.origin.url", silent=True)
42
- if "pawamoy-insiders/griffe" in origin:
43
- ctx.run(
44
- lambda: False,
45
- title="Not running this task from insiders repository (do that from public repo instead!)",
46
- )
47
- return
48
- func(ctx, *args, **kwargs)
49
-
50
- return wrapper
51
-
52
-
53
- @contextmanager
54
- def material_insiders() -> Iterator[bool]:
55
- if "+insiders" in pkgversion("mkdocs-material"):
56
- os.environ["MATERIAL_INSIDERS"] = "true"
57
- try:
58
- yield True
59
- finally:
60
- os.environ.pop("MATERIAL_INSIDERS")
61
- else:
62
- yield False
63
-
64
-
65
35
  def _get_changelog_version() -> str:
66
36
  changelog_version_re = re.compile(r"^## \[(\d+\.\d+\.\d+)\].*$")
67
37
  with Path(__file__).parent.joinpath("CHANGELOG.md").open("r", encoding="utf8") as file:
@@ -84,7 +54,7 @@ def check(ctx: Context) -> None:
84
54
  """Check it all!"""
85
55
 
86
56
 
87
- @duty
57
+ @duty(nofail=PY_VERSION == PY_DEV)
88
58
  def check_quality(ctx: Context) -> None:
89
59
  """Check the code quality."""
90
60
  ctx.run(
@@ -93,19 +63,18 @@ def check_quality(ctx: Context) -> None:
93
63
  )
94
64
 
95
65
 
96
- @duty
66
+ @duty(nofail=PY_VERSION == PY_DEV)
97
67
  def check_docs(ctx: Context) -> None:
98
68
  """Check if the documentation builds correctly."""
99
69
  Path("htmlcov").mkdir(parents=True, exist_ok=True)
100
70
  Path("htmlcov/index.html").touch(exist_ok=True)
101
- with material_insiders():
102
- ctx.run(
103
- tools.mkdocs.build(strict=True, verbose=True),
104
- title=pyprefix("Building documentation"),
105
- )
71
+ ctx.run(
72
+ tools.mkdocs.build(strict=True, verbose=True),
73
+ title=pyprefix("Building documentation"),
74
+ )
106
75
 
107
76
 
108
- @duty
77
+ @duty(nofail=PY_VERSION == PY_DEV)
109
78
  def check_types(ctx: Context) -> None:
110
79
  """Check that the code is correctly typed."""
111
80
  os.environ["MYPYPATH"] = "src"
@@ -116,7 +85,7 @@ def check_types(ctx: Context) -> None:
116
85
  )
117
86
 
118
87
 
119
- @duty
88
+ @duty(nofail=PY_VERSION == PY_DEV)
120
89
  def check_api(ctx: Context, *cli_args: str) -> None:
121
90
  """Check for API breaking changes."""
122
91
  ctx.run(
@@ -134,48 +103,18 @@ def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000
134
103
  host: The host to serve the docs from.
135
104
  port: The port to serve the docs on.
136
105
  """
137
- with material_insiders():
138
- ctx.run(
139
- tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args),
140
- title="Serving documentation",
141
- capture=False,
142
- )
106
+ ctx.run(
107
+ tools.mkdocs.serve(dev_addr=f"{host}:{port}").add_args(*cli_args),
108
+ title="Serving documentation",
109
+ capture=False,
110
+ )
143
111
 
144
112
 
145
113
  @duty
146
- def docs_deploy(ctx: Context, *, force: bool = False) -> None:
147
- """Deploy the documentation to GitHub pages.
148
-
149
- Parameters:
150
- force: Whether to force deployment, even from non-Insiders version.
151
- """
114
+ def docs_deploy(ctx: Context) -> None:
115
+ """Deploy the documentation to GitHub pages."""
152
116
  os.environ["DEPLOY"] = "true"
153
- with material_insiders() as insiders:
154
- if not insiders:
155
- ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
156
- origin = ctx.run("git config --get remote.origin.url", silent=True, allow_overrides=False)
157
- if "pawamoy-insiders/mkdocstrings-typescript" in origin:
158
- ctx.run(
159
- "git remote add upstream git@github.com:mkdocstrings/typescript",
160
- silent=True,
161
- nofail=True,
162
- allow_overrides=False,
163
- )
164
- ctx.run(
165
- tools.mkdocs.gh_deploy(remote_name="upstream", force=True),
166
- title="Deploying documentation",
167
- )
168
- elif force:
169
- ctx.run(
170
- tools.mkdocs.gh_deploy(force=True),
171
- title="Deploying documentation",
172
- )
173
- else:
174
- ctx.run(
175
- lambda: False,
176
- title="Not deploying docs from public repository (do that from insiders instead!)",
177
- nofail=True,
178
- )
117
+ ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation")
179
118
 
180
119
 
181
120
  @duty
@@ -199,7 +138,6 @@ def build(ctx: Context) -> None:
199
138
 
200
139
 
201
140
  @duty
202
- @not_from_insiders
203
141
  def publish(ctx: Context) -> None:
204
142
  """Publish source and wheel distributions to PyPI."""
205
143
  if not Path("dist").exists():
@@ -213,7 +151,6 @@ def publish(ctx: Context) -> None:
213
151
 
214
152
 
215
153
  @duty(post=["build", "publish", "docs-deploy"])
216
- @not_from_insiders
217
154
  def release(ctx: Context, version: str = "") -> None:
218
155
  """Release a new Python package.
219
156
 
@@ -224,7 +161,7 @@ def release(ctx: Context, version: str = "") -> None:
224
161
  ctx.run("false", title="A version must be provided")
225
162
  ctx.run("git add pyproject.toml CHANGELOG.md", title="Staging files", pty=PTY)
226
163
  ctx.run(["git", "commit", "-m", f"chore: Prepare release {version}"], title="Committing changes", pty=PTY)
227
- ctx.run(f"git tag {version}", title="Tagging commit", pty=PTY)
164
+ ctx.run(f"git tag -m '' -a {version}", title="Tagging commit", pty=PTY)
228
165
  ctx.run("git push", title="Pushing commits", pty=False)
229
166
  ctx.run("git push --tags", title="Pushing tags", pty=False)
230
167
 
@@ -237,20 +174,15 @@ def coverage(ctx: Context) -> None:
237
174
  ctx.run(tools.coverage.html(rcfile="config/coverage.ini"))
238
175
 
239
176
 
240
- @duty
241
- def test(ctx: Context, *cli_args: str, match: str = "") -> None:
242
- """Run the test suite.
243
-
244
- Parameters:
245
- match: A pytest expression to filter selected tests.
246
- """
247
- py_version = f"{sys.version_info.major}{sys.version_info.minor}"
248
- os.environ["COVERAGE_FILE"] = f".coverage.{py_version}"
177
+ @duty(nofail=PY_VERSION == PY_DEV)
178
+ def test(ctx: Context, *cli_args: str) -> None:
179
+ """Run the test suite."""
180
+ os.environ["COVERAGE_FILE"] = f".coverage.{PY_VERSION}"
181
+ os.environ["PYTHONWARNDEFAULTENCODING"] = "1"
249
182
  ctx.run(
250
183
  tools.pytest(
251
184
  "tests",
252
185
  config_file="config/pytest.ini",
253
- select=match,
254
186
  color="yes",
255
187
  ).add_args("-n", "auto", *cli_args),
256
188
  title=pyprefix("Running tests"),
@@ -31,12 +31,7 @@ nav:
31
31
  - Contributing: contributing.md
32
32
  - Code of Conduct: code_of_conduct.md
33
33
  - Coverage report: coverage.md
34
- - Insiders:
35
- - insiders/index.md
36
- - Getting started:
37
- - Installation: insiders/installation.md
38
- - Changelog: insiders/changelog.md
39
- - mkdocstrings: https://mkdocstrings.github.io/
34
+ - mkdocstrings: https://mkdocstrings.github.io/
40
35
 
41
36
  theme:
42
37
  name: material
@@ -83,7 +78,6 @@ theme:
83
78
  extra_css:
84
79
  - css/material.css
85
80
  - css/mkdocstrings.css
86
- - css/insiders.css
87
81
 
88
82
  extra_javascript:
89
83
  - js/feedback.js
@@ -151,27 +145,25 @@ plugins:
151
145
  show_root_heading: true
152
146
  show_root_full_path: false
153
147
  show_signature_annotations: true
154
- show_source: false
148
+ show_source: true
155
149
  show_symbol_type_heading: true
156
150
  show_symbol_type_toc: true
157
151
  signature_crossrefs: true
158
152
  summary: true
159
153
  - llmstxt:
160
- files:
161
- - output: llms-full.txt
162
- inputs:
154
+ full_output: llms-full.txt
155
+ sections:
156
+ Usage:
163
157
  - index.md
164
- - reference/**.md
158
+ API:
159
+ - reference/api.md
165
160
  - git-revision-date-localized:
166
161
  enabled: !ENV [DEPLOY, false]
167
162
  enable_creation_date: true
168
163
  type: timeago
169
164
  - minify:
170
165
  minify_html: !ENV [DEPLOY, false]
171
- - group:
172
- enabled: !ENV [MATERIAL_INSIDERS, false]
173
- plugins:
174
- - typeset
166
+ - typeset
175
167
 
176
168
  extra:
177
169
  social:
@@ -15,7 +15,7 @@ license-files = [
15
15
  "LICENSE",
16
16
  ]
17
17
  readme = "README.md"
18
- requires-python = ">=3.10"
18
+ requires-python = ">=3.11"
19
19
  keywords = []
20
20
  dynamic = []
21
21
  classifiers = [
@@ -24,7 +24,6 @@ classifiers = [
24
24
  "Programming Language :: Python",
25
25
  "Programming Language :: Python :: 3",
26
26
  "Programming Language :: Python :: 3 :: Only",
27
- "Programming Language :: Python :: 3.10",
28
27
  "Programming Language :: Python :: 3.11",
29
28
  "Programming Language :: Python :: 3.12",
30
29
  "Programming Language :: Python :: 3.13",
@@ -38,7 +37,7 @@ dependencies = [
38
37
  "mkdocstrings>=0.28.3",
39
38
  "griffe-typedoc>=0.1",
40
39
  ]
41
- version = "0.1.0"
40
+ version = "0.1.1"
42
41
 
43
42
  [project.urls]
44
43
  Homepage = "https://mkdocstrings.github.io/typescript"
@@ -112,11 +111,10 @@ docs = [
112
111
  "mkdocs>=1.6",
113
112
  "mkdocs-coverage>=1.0",
114
113
  "mkdocs-git-revision-date-localized-plugin>=1.2",
115
- "mkdocs-llmstxt>=0.1",
114
+ "mkdocs-llmstxt>=0.2",
116
115
  "mkdocs-material>=9.5",
117
116
  "mkdocs-minify-plugin>=0.8",
118
117
  "mkdocs-section-index>=0.3",
119
118
  "mkdocstrings[python]>=0.29",
120
119
  "pydantic>=2.10",
121
- "tomli>=2.0; python_version < '3.11'",
122
120
  ]