-
-
Notifications
You must be signed in to change notification settings - Fork 820
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 code documentation #4702
Comments
It might be an idea to add a decorator to functions we wish to specify as "API" functions (which we make an effort not to change), while some functions are marked as internal. Or mark internal functions with an underscore prefix, or similar. Having an API of public functions would help to make them more discoverable for inclusion in generated reports, for example |
@SchrodingersGat I think it makes sense to only expose things we want to be included specifically like plugin mixins. |
So you would suggest an "opt in" approach for which classes and methods we expose? |
This issue seems stale. Please react to show this is still important. |
not stale |
This issue seems stale. Please react to show this is still important. |
Still important |
This issue seems stale. Please react to show this is still important. |
still important |
This issue seems stale. Please react to show this is still important. |
I think this is still relevant because this would reduce a lot of duplicate documentation in the docstrings and the documentation. The suggested library was now also already added as part of #4824 documentation. |
Body of the issue
Ref: #2493 (comment)
Ref: https://github.com/mkdocstrings/mkdocstrings
Build code documentation into the InvenTree docs automatically
The text was updated successfully, but these errors were encountered: