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.

Sign up for GitHub

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

Jump to bottom

PyAnIML misses a documentation #4

Open
JR-1991 opened this issue Mar 20, 2022 · 0 comments
Open

PyAnIML misses a documentation #4

JR-1991 opened this issue Mar 20, 2022 · 0 comments
Assignees
@JR-1991
Labels
documentation Improvements or additions to documentation

Comments

@JR-1991
Copy link
Contributor

JR-1991 commented Mar 20, 2022

Documentation should be set-up compliant to PyDantic, the Sphinx extension sphinxcontrib.autodoc_pydantic is superb. Maybe also add multiple examples where we show an application that is utilizing pyAnIML rather than just demonstrating on toy examples.
@JR-1991 JR-1991 added the documentation Improvements or additions to documentation label Mar 20, 2022
@JR-1991 JR-1991 self-assigned this Mar 20, 2022
@JR-1991 JR-1991 pinned this issue Mar 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JR-1991 JR-1991

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JR-1991