-
Notifications
You must be signed in to change notification settings - Fork 17
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
add documentation #8
Comments
Shouldn't this issue be more about having a nice documentation on ReadTheDocs, like https://xeus-python-kernel.readthedocs.io ? |
At some point we should have a readthedocs documentation. But with this issue I just ment some minimal documentation st. other people can start to play around with it. |
see #17 |
Right. mkdocs would be fine, although the sphinx / pydata-sphinx-theme is still commonly used across Jupyter repos, it could make sense to stick to it for the time being (and maybe suggest mkdocs as an alternative for the future?) In terms of work, copy pasting https://github.com/jupyterlite/xeus-python-kernel/tree/main/docs here would likely do most of it. |
A lot of the documentation can be copy pasted from https://github.com/jupyterlite/xeus-python-kernel, yet we need a bit more, since this repo has more capabilities.
The text was updated successfully, but these errors were encountered: