You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Project repo will need to include useful documentation about what the project is, it's source data, and how to implement methods. This will include OpenAPI/Swagger documentation of API endpoints, readme around context/quickstart/contribution guidelines, as well as actual pythondocs. Allowing teams to autogenerate documentation based on docstrings and readmes, would aid in process
Context
This would aid developers in creating documentation in an efficient manner
Possible Implementation
While sphinx appears to be the most complete option, including docstring support, it appears that using markdown vs. rst may cause some issues? mkdocs would be additional option,.
DRF can autogenerate the openapi
Detailed Description
Project repo will need to include useful documentation about what the project is, it's source data, and how to implement methods. This will include OpenAPI/Swagger documentation of API endpoints, readme around context/quickstart/contribution guidelines, as well as actual pythondocs. Allowing teams to autogenerate documentation based on docstrings and readmes, would aid in process
Context
This would aid developers in creating documentation in an efficient manner
Possible Implementation
While sphinx appears to be the most complete option, including docstring support, it appears that using markdown vs. rst may cause some issues? mkdocs would be additional option,.
DRF can autogenerate the openapi
Your Environment
n/a
The text was updated successfully, but these errors were encountered: