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

Re-create documentation #10

Open

4 tasks

tadejsv opened this issue Aug 14, 2021 · 0 comments

Assignees

Labels

Owner

tadejsv commented Aug 14, 2021 •

edited

Loading

This ticket combines several tasks that are needed to create the first version of user-friendly documentation:

Move documentation from current sphinx format to Material for MkDocs (includes re-formatting docstrings)
Add a useful README page, should have description, installation instructions + some quick examples
Use mkdocstrings for API reference
Start off with some useful examples/guides for general documentation

tadejsv self-assigned this

tadejsv added the documentation label

tadejsv changed the title ~~Add some usage examples to documentation~~ Re-create documentation

tadejsv mentioned this issue

Add a readme page #8

Closed

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