Unified documentation structure for libraries #60
Locked
AndrewSazonov
announced in
ADRs
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
To enhance consistency and usability across EasyScience-based data analysis libraries, the documentation structure is standardized with the following main sections:
A documentation skeleton is included in the Copier templates:
https://github.com/easyscience/templates/tree/master/template/docs
A CI workflow for building documentation via GitHub Actions (also included in the Copier templates):
https://github.com/easyscience/templates/blob/master/template/.github/workflows/docs.yml.jinja
A guide on how to build and check the documentation locally:
https://github.com/easyscience/templates/blob/master/README.md
Example of a generated documentation skeleton:
https://easyscience.github.io/peasy-lib
Links to the original discussions: #24
Beta Was this translation helpful? Give feedback.
All reactions