Skip to content

auto_mode is never explained / missing? #1031

@nerdoc

Description

@nerdoc

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions