Releases: pyodide/sphinx-js
Releases · pyodide/sphinx-js
5.0.0
- Dropped support for Python 3.9 (pyodide#7)
- Dropped support for typedoc 0.15, added support for typedoc 0.25--0.28
(pyodide#11, pyodide#22, pyodide#31, pyodide#39, pyodide#41, pyodide#43 pyodide#52, pyodide#53, pyodide#54, pyodide#174, #266) - Added handling for TypeScript type parameters and type bounds.
(pyodide#25) - Only monkeypatch Sphinx classes when sphinx_js extension is used
(pyodide#27) - Allow using installation of
typedoc
orjsdoc
fromnode_modules
instead of requiring global install. (pyodide#33) - Handle markdown style codepens correctly in typedoc comments.
(pyodide#47) - Added support for destructuring the documentation of keyword arguments in
TypeScript using the@destructure
tag or the
shouldDestructureArg
hook.
(pyodide#48, pyodide#74, pyodide#75, pyodide#101, pyodide#128) - Added rendering for cross references in TypeScript types.
(pyodide#51, pyodide#56, pyodide#67, pyodide#81, pyodide#82, pyodide#83, pyodide#153, pyodide#160) - Added rendering for function types in TypeScript documentation.
(pyodide#55, pyodide#58, pyodide#59) - Add async prefix to async functions (pyodide#65).
- Added the
sphinx-js_type
css class around all types in documentation. This
allows applying custom css just to types (pyodide#85) - Added
ts_type_bold
config option that applies css to.sphinx-js_type
to render all types as bold. - Added
js:automodule
directive (pyodide#108) - Added
js:autosummary
directive (pyodide#109) - Added rendering for
queryType
(e.g.,let y: typeof x;
)
(pyodide#124) - Added rendering for
typeOperator
(e.g.,let y: keyof x
)
(pyodide#125) - Fixed crash when objects are reexported. (pyodide#126)
- Added
jsdoc_tsconfig_path
which can specify the path to the
tsconfig.json
file that should be used. (pyodide#116) - Added a
js:interface
directive (pyodide#138). - Removed parentheses from xrefs to classes (pyodide#155).
- Added a
:js:typealias:
directive (pyodide#156). - Added rendering for conditional, indexed access, inferred, mapped, optional,
rest, and template litreal types (pyodide#157). - Added readonly prefix to readonly properties (pyodide#158).