We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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...
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:
MyST-Parser/docs/syntax/code_and_apis.md
Line 173 in 8a44f5d
So is this not implemented yet?
The text was updated successfully, but these errors were encountered:
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.
Sorry, something went wrong.
add link to auto_mode in sphinx-autodoc2
ae1bcc2
fixes executablebooks#1031
Successfully merging a pull request may close this issue.
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:
MyST-Parser/docs/syntax/code_and_apis.md
Line 173 in 8a44f5d
So is this not implemented yet?
The text was updated successfully, but these errors were encountered: