Skip to content
New issue

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

auto_mode is never explained / missing? #1031

Open
nerdoc opened this issue Mar 10, 2025 · 1 comment · May be fixed by #1032
Open

auto_mode is never explained / missing? #1031

nerdoc opened this issue Mar 10, 2025 · 1 comment · May be fixed by #1032

Comments

@nerdoc
Copy link

nerdoc commented Mar 10, 2025

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:

The `auto_mode` will automatically generate the full API documentation, as shown <project:/apidocs/index.rst>.

So is this not implemented yet?

@nerdoc nerdoc changed the title Issue on page /syntax/code_and_apis.html: auto_mode is never explained auto_mode is never explained / missing? Mar 10, 2025
@nerdoc
Copy link
Author

nerdoc commented Mar 10, 2025

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 added a commit to nerdoc/MyST-Parser that referenced this issue Mar 10, 2025
@nerdoc nerdoc linked a pull request Mar 10, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant