search

jupyterlite / jupyterlite-sphinx

Sphinx extension using JupyterLite to render Notebooks
https://jupyterlite-sphinx.readthedocs.io/en/latest
BSD 3-Clause "New" or "Revised" License
68 stars 21 forks source link

Dev docs #125

Open Carreau opened 10 months ago

Carreau commented 10 months ago

I'm guessing the docs are build using hatch ? But I don't use hatch so i'm strugling to find how to run the right commands.

But in general it would be good to have minimal dev docs on how to do things.

martinRenou commented 10 months ago

in general it would be good to have minimal dev docs on how to do things.

Agreed!

I'm guessing the docs are build using hatch ?

It's just using sphinx build, so you can run something like sphinx build . output from the docs directery, this is more or less what readthedocs does. Build dependencies are specified in https://github.com/jupyterlite/jupyterlite-sphinx/blob/main/dev-environment.yml

agriyakhetarpal commented 8 months ago

I just noticed this issue, and I think that this ties in nicely with adding a guide for new contributors. I would be happy to pick this up soon.