jupyterlite-sphinx icon indicating copy to clipboard operation
jupyterlite-sphinx copied to clipboard

Dev docs

Open Carreau opened this issue 5 months ago • 2 comments

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.

Carreau avatar Jan 24 '24 10:01 Carreau

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

martinRenou avatar Jan 24 '24 11:01 martinRenou

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.

agriyakhetarpal avatar Mar 29 '24 20:03 agriyakhetarpal