Skip to content

feature: Simplified single file setup for API documentation link (like pydoc-markdown YAML) #5

@mcarans

Description

@mcarans

Is your feature request related to a problem? Please describe.

I have been looking for a library to replace pydoc-markdown which is no longer developed. The author of that library recommended mkdocstrings. The requirements for my documentation are simple, just a single markdown page and the API documentation available from a menu on the left. This is very easy to do with pydoc-markdown YAML (the old style with that library).

I am looking for a similar easy single file setup. If this is already possible with mkdocstrings and griffe2md, it isn't clear to me from the documentation how to set it up.

Describe the solution you'd like

I would like to generate documentation that looks like this. pydoc-markdown's setup is just a single YAML file. I would like to be able to make a very easy setup like this for a number of libraries of mine using mkdocstrings and griffe2md.

Describe alternatives you've considered

The only alternative is continuing to use pydoc-markdown which is no longer being developed.

Additional context

The readthedocs configuration of pydoc-markdown is here and my markdown file is here. Along with the YAML file, that's all that's needed to produce the documentation on readthedocs, an image of which is below:

Image

Metadata

Metadata

Assignees

Labels

featureNew feature or requestinsidersCandidate for Insiders

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions