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

Migrate reference documentation to readthedocs #73

Open
sbesson opened this issue Apr 15, 2022 · 0 comments
Open

Migrate reference documentation to readthedocs #73

sbesson opened this issue Apr 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sbesson
Copy link
Member

sbesson commented Apr 15, 2022

The current strategy of capturing the full reference documentation of this library/plugin has some scaling issues e.g. as the documentation of the default context tries to cover the supported scenarios more extensively.

Similarly to what has been done in https://github.com/ome/ome-zarr-py with https://ome-zarr.readthedocs.io/en/stable/, we might consider migrating and supplementating the existing content using readthedocs. The README would still contain the quickstart documentation but include pointers to the reference documentation for detailed information.

@sbesson sbesson added the documentation Improvements or additions to documentation label Apr 15, 2022
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