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

Sphinx documentation #20

Open
jacobhinkle opened this issue May 13, 2021 · 0 comments
Open

Sphinx documentation #20

jacobhinkle opened this issue May 13, 2021 · 0 comments

Comments

@jacobhinkle
Copy link
Owner

Is your feature request related to a problem? Please describe.
We currently have https://lagomorph.readthedocs.io/en/latest/ set up but there is no documentation yet.

Describe the solution you'd like
Add simple sphinx docs.

Describe alternatives you've considered
NA

Additional context
The datawork documentation works pretty well I think: https://datawork.readthedocs.io/en/latest/
However, for lagomorph it would be good to group the API documentation separate from an introduction and guides, and perhaps even having an LDDMM overview section. Documentation building should also be part of the CI pipeline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant