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

Enable Autodocs #34

Open
Hierosme opened this issue Oct 4, 2024 · 2 comments
Open

Enable Autodocs #34

Hierosme opened this issue Oct 4, 2024 · 2 comments

Comments

@Hierosme
Copy link

Hierosme commented Oct 4, 2024

The documentation hide inside code should be parse by a framework like sphinx or mkdocs,
I recommand sphinx for it autodocs plugins.

The docstring format is not a issue but should be verify by a linter like ruff, then consider a ruff approch and reformat

The need to generate the documentation by readthedocs can be done by add a .readthedocs.yml file on the root of the project.

@Hierosme
Copy link
Author

Hierosme commented Oct 4, 2024

Happy if can address it issue

@TheJoin95
Copy link
Member

Happy if can address it issue

It could be nice, thanks!

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

No branches or pull requests

2 participants