MyST-Parser icon indicating copy to clipboard operation
MyST-Parser copied to clipboard

auto_mode is never explained / missing?

Open nerdoc opened this issue 9 months ago • 1 comments

I want to document my API with sphinx/myst/autodoc2.

According to https://myst-parser.readthedocs.io/en/latest/syntax/code_and_apis.html#sphinx-autodoc2, there is an "auto_mode" with a link "as shown API Reference." But the API reference IMHO is only the API of MYST itself, and does not contain any auto_mode.

A search for "auto_mode" references only the one link (see before), and it is never explained how to use the auto_mode...

Is this completely missing/forgotten? Does auto_mode exist? If I search the whole Github repo for "auto_mode", I only get one line: https://github.com/executablebooks/MyST-Parser/blob/8a44f5d35197b19aab2f1fe35b6f1dce4960bce5/docs/syntax/code_and_apis.md?plain=1#L173

So is this not implemented yet?

nerdoc avatar Mar 10 '25 10:03 nerdoc

AAARGH. Always the same. Searched for 2 hours now, and right after writing an issue, found it. It is part of sphinx-autodoc2, not MYST-parser...

But - this is still an issue: you should explain that and maybe place a link to that... I can add a PR if it's ok.

nerdoc avatar Mar 10 '25 10:03 nerdoc