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

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

Open
s2t2 opened this issue May 23, 2024 · 1 comment
Open

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

s2t2 opened this issue May 23, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@s2t2
Copy link

s2t2 commented May 23, 2024

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.

@s2t2 s2t2 added the documentation Improvements or additions to documentation label May 23, 2024
Copy link

welcome bot commented May 23, 2024

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

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! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant