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 code documentation #4702

Open
SchrodingersGat opened this issue Apr 26, 2023 · 11 comments
Open

Add code documentation #4702

SchrodingersGat opened this issue Apr 26, 2023 · 11 comments
Labels
documentation inactive Indicates lack of activity
Milestone

Comments

@SchrodingersGat
Copy link
Member

Body of the issue

Ref: #2493 (comment)

Ref: https://github.com/mkdocstrings/mkdocstrings

Build code documentation into the InvenTree docs automatically

@SchrodingersGat
Copy link
Member Author

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

@matmair
Copy link
Member

matmair commented Apr 29, 2023

@SchrodingersGat I think it makes sense to only expose things we want to be included specifically like plugin mixins.

@SchrodingersGat
Copy link
Member Author

So you would suggest an "opt in" approach for which classes and methods we expose?

@github-actions
Copy link
Contributor

This issue seems stale. Please react to show this is still important.

@github-actions github-actions bot added the inactive Indicates lack of activity label Jun 29, 2023
@SchrodingersGat
Copy link
Member Author

not stale

@SchrodingersGat SchrodingersGat removed the inactive Indicates lack of activity label Jun 29, 2023
@github-actions
Copy link
Contributor

This issue seems stale. Please react to show this is still important.

@github-actions github-actions bot added the inactive Indicates lack of activity label Aug 29, 2023
@matmair
Copy link
Member

matmair commented Aug 30, 2023

Still important

@github-actions github-actions bot removed the inactive Indicates lack of activity label Aug 31, 2023
@github-actions
Copy link
Contributor

This issue seems stale. Please react to show this is still important.

@github-actions github-actions bot added the inactive Indicates lack of activity label Oct 31, 2023
@matmair
Copy link
Member

matmair commented Nov 2, 2023

still important

@github-actions github-actions bot removed the inactive Indicates lack of activity label Nov 3, 2023
Copy link
Contributor

github-actions bot commented Jan 4, 2024

This issue seems stale. Please react to show this is still important.

@github-actions github-actions bot added the inactive Indicates lack of activity label Jan 4, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Jan 11, 2024
@wolflu05
Copy link
Contributor

wolflu05 commented Apr 3, 2024

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.

@wolflu05 wolflu05 reopened this Apr 3, 2024
@SchrodingersGat SchrodingersGat added this to the horizon milestone Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation inactive Indicates lack of activity
Projects
None yet
Development

No branches or pull requests

3 participants