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

Sphinx API and Example documentation #14

Open

dsteinberg opened this issue Feb 1, 2022 · 1 comment

Labels

Contributor

dsteinberg commented Feb 1, 2022

like aboleth:

https://aboleth.readthedocs.io/en/stable/?badge=stable

dsteinberg added the documentation label

jack-fs mentioned this issue

Update/fix documentation #47

Open

Contributor

jack-fs commented Jan 30, 2023 •

edited

Work is underway in the sphinx branch.

In terms of documentation generation, a clear next step is to pretty-up the generated documentation:

cross-linking for ease of navigation (e.g. estimator.fit() in the image could link to the appropriate docs)
improve spacing and layout (e.g. well-typed function signatures look very cluttered, see image)

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