From review of #56: docs/api/index.md embeds its API reference in
```{eval-rst} blocks (.. autoclass::, .. autofunction::,
.. currentmodule::), so the file is MyST markdown wrapping reStructuredText.
Everything else under docs/ is markdown. The rst blocks mean two syntaxes in
one file, two sets of escaping rules, and directives that do not render on
GitHub.
sphinx-autodoc2 or MyST's own {py:class} / {py:function} directives can
express the same thing in markdown. Worth checking whether the cross-reference
roles already used throughout the guides ({class}, {func}, {meth}) cover
the linking, in which case only the auto* directives need replacing.
Not urgent and deliberately out of scope for #56.
馃 Generated with Claude Code
From review of #56:
docs/api/index.mdembeds its API reference in```{eval-rst}blocks (.. autoclass::,.. autofunction::,.. currentmodule::), so the file is MyST markdown wrapping reStructuredText.Everything else under
docs/is markdown. The rst blocks mean two syntaxes inone file, two sets of escaping rules, and directives that do not render on
GitHub.
sphinx-autodoc2or MyST's own{py:class}/{py:function}directives canexpress the same thing in markdown. Worth checking whether the cross-reference
roles already used throughout the guides (
{class},{func},{meth}) coverthe linking, in which case only the
auto*directives need replacing.Not urgent and deliberately out of scope for #56.
馃 Generated with Claude Code