Skip to content

Add Documentation Generation #35

@bhgrant8

Description

@bhgrant8

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

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestmvpEnhancement is core to project, needs to be addressed

Type

No type
No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions