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 #79

Open
Tracked by #44
ma595 opened this issue Oct 16, 2024 · 0 comments
Open
Tracked by #44

Sphinx documentation #79

ma595 opened this issue Oct 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@ma595
Copy link
Collaborator

ma595 commented Oct 16, 2024

A useful way to provide documentation is with Sphinx (with read the docs - rtd - template). This would allow us to store all of the contributions ICCS have made as well as a tutorial and developer guide.

It could also provide the API to the users, taking docstring information from the code.

This could be deployed in an automated fashion using Github actions.

@ma595 ma595 added this to the Documentation milestone Oct 16, 2024
@ma595 ma595 added the documentation Improvements or additions to documentation label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant