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 Documentation Generation #35

Open
bhgrant8 opened this issue Jun 9, 2019 · 0 comments
Open

Add Documentation Generation #35

bhgrant8 opened this issue Jun 9, 2019 · 0 comments
Assignees
Labels
enhancement New feature or request mvp Enhancement is core to project, needs to be addressed
Milestone

Comments

@bhgrant8
Copy link
Member

bhgrant8 commented Jun 9, 2019

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

@bhgrant8 bhgrant8 self-assigned this Jun 9, 2019
@bhgrant8 bhgrant8 added enhancement New feature or request mvp Enhancement is core to project, needs to be addressed labels Jun 9, 2019
@bhgrant8 bhgrant8 added this to the 0.7.5 milestone Jun 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request mvp Enhancement is core to project, needs to be addressed
Projects
None yet
Development

No branches or pull requests

1 participant