We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
The documentation hide inside code should be parse by a framework like sphinx or mkdocs, I recommand sphinx for it autodocs plugins.
sphinx
mkdocs
The docstring format is not a issue but should be verify by a linter like ruff, then consider a ruff approch and reformat
ruff
The need to generate the documentation by readthedocs can be done by add a .readthedocs.yml file on the root of the project.
.readthedocs.yml
The text was updated successfully, but these errors were encountered:
Happy if can address it issue
Sorry, something went wrong.
It could be nice, thanks!
No branches or pull requests
The documentation hide inside code should be parse by a framework like
sphinx
ormkdocs
,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 reformatThe need to generate the documentation by readthedocs can be done by add a
.readthedocs.yml
file on the root of the project.The text was updated successfully, but these errors were encountered: