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

Dev docs #125

Open
Carreau opened this issue Jan 24, 2024 · 2 comments
Open

Dev docs #125

Carreau opened this issue Jan 24, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Carreau
Copy link
Collaborator

Carreau commented Jan 24, 2024

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 Carreau added the documentation Improvements or additions to documentation label Jan 24, 2024
@martinRenou
Copy link
Member

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
Copy link
Contributor

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.

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

3 participants