executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
708 stars 189 forks source link

Add example config.yml entries for autodoc-2 #933

Open s2t2 opened 1 month ago

s2t2 commented 1 month ago

Describe the gap in the current documentation

Goal is to create auto documentation. The docs recommend sphinx-autodoc2 but they don't provide example content to include in the "_config.yml" file.

What content do you put in the "_config.yml" file to make sphinx-autodoc2 work?

Describe the solution you'd like

Add to the docs on the page referenced the content necessary for the "config.yml" in order to make autodoc2 work.

welcome[bot] commented 1 month ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada: