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.

Sign up for GitHub

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

Jump to bottom

Add documentation with automated builds #40

Open

niksirbi opened this issue Apr 3, 2023 · 0 comments

Member

niksirbi commented Apr 3, 2023

Add documentation using Sphinx and the Pydata Sphinx theme.
Automate documentation build either via GitHub Actions or via readthedocs.org
Publish the docs on a repository GitHub page or on readthedocs.org (or alternatively, setup a custom domain)

The documentation can include:

Narrative documentation: How To guides, Getting Started guides, Tutorials, Examples (can incorporate existing Jupyter Notebooks)
API documentation: this can be automatically built from existing docstrings via Sphinx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment