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

API Reference: class methods have no documentation #1241

Open
Huite opened this issue Oct 16, 2024 · 1 comment
Open

API Reference: class methods have no documentation #1241

Huite opened this issue Oct 16, 2024 · 1 comment
Milestone

Comments

@Huite
Copy link
Contributor

Huite commented Oct 16, 2024

See for example the MF6 River documentation:

https://deltares.github.io/imod-python/api/generated/mf6/imod.mf6.River.html

The methods have no generated pages associated with them, since we've chosen to specify the generated methods manually. We should probably use a different sphinx directive here to make sure these methods are in fact generated, although they don't have to be available in the index.

@github-project-automation github-project-automation bot moved this to 📯 New in iMOD Suite Oct 16, 2024
@JoerivanEngelen JoerivanEngelen added this to the v1.0 release milestone Oct 21, 2024
@JoerivanEngelen JoerivanEngelen moved this from 📯 New to 🤝 Accepted in iMOD Suite Oct 21, 2024
@JoerivanEngelen
Copy link
Contributor

Switching to ''autoapi'' might help https://bylr.info/articles/2022/05/10/api-doc-with-sphinx-autoapi/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🤝 Accepted
Development

No branches or pull requests

2 participants