Skip to content

Allow adding extra documentation in Markdown format #342

@ssbarnea

Description

@ssbarnea

While Sphinx itself can use ME instead of RST via MyST sphinx plugin, anstibul-docs is unable to expose markdown files as links (even if sphinx does build the files correctly)

I am referring to https://ansible.readthedocs.io/projects/antsibull-docs/collection-docs/#adding-extra-documentation which documents on how to make extra documentation visible.

This problem is quite important because current collection packaging allows ONLY markdown documentation to be rendered in galaxy/hub, this being the only official way to ship documentation as part of the collection itself.

I suspect that this can easily be addressed by relaxing the check done by antsibull-docs.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions