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

add documentation #8

Closed
DerThorsten opened this issue Dec 13, 2023 · 5 comments
Closed

add documentation #8

DerThorsten opened this issue Dec 13, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@DerThorsten
Copy link
Collaborator

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.

@DerThorsten
Copy link
Collaborator Author

#16

@jtpio
Copy link
Member

jtpio commented Jan 5, 2024

Shouldn't this issue be more about having a nice documentation on ReadTheDocs, like https://xeus-python-kernel.readthedocs.io ?

@DerThorsten
Copy link
Collaborator Author

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.
I will add another issue for the rtd build. Btw the prefix.dev team moved all their documentation from readthedocs to mkdocs on github pages.

@DerThorsten
Copy link
Collaborator Author

DerThorsten commented Jan 5, 2024

see #17

@jtpio
Copy link
Member

jtpio commented Jan 5, 2024

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.

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

2 participants