Add typedoc setup and integrate into main docs #13213
Open
+478
−28
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
laymonage
force-pushed
the
docs/typedoc
branch
2 times, most recently
from
f9462ae to
95e78c6
Compare
laymonage
changed the title
laymonage
commented
Jul 10, 2025
|
|
||
| ## Releases | ||
|
|
||
| The front-end is bundled at the same time as the Wagtail project. This package also aims to be available separately on npm as [`wagtail`](https://www.npmjs.com/package/wagtail). |
There was a problem hiding this comment.
Removing all this since I don't see any movement towards this effort in the years since this was introduced: https://github.com/wagtail/wagtail/commits/main/client/README.md
and I don't see us heading towards that direction any time soon.
Comment on lines
+195
to
+197
| myst_enable_extensions = [ | ||
| "attrs_inline", | ||
| ] |
There was a problem hiding this comment.
Needed for the .external link modifier in reference/client.md to work, so that the relative link to the client-side docs is resolved as an external link instead of treated as a Sphinx document link.
See:
docs/reference/client.md
Outdated
Comment on lines
5
to
9
| ```{include} ../../client/README.md | ||
| :end-before: <!-- END --> | ||
| ``` | ||
|
|
||
| [Proceed to the client-side API documentation.](./client/index.html){.external} |
There was a problem hiding this comment.
This allows us to reuse the same paragraphs for the intro in both the Sphinx docs and the Typedoc docs, but with different links to navigate to each other.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://wagtail--13213.org.readthedocs.build/en/13213/reference/ui/index.html
TBD, whether to:
Integrating with sphinx-js still has some blockers, e.g. pyodide/sphinx-js#275. I also couldn't get typedoc-plugin-mdn-links to work with it, unfortunately.