Add documentation with Jupyterlite demo

[brichet]

This adds a first documentation including a jupyterlite demo.

Wait for jupyterlite/jupyterlite-sphinx#108 to be merged.

Fixes #6

[github-actions]

👈 Launch a Binder on branch jupyterlite/litegitpuller/readthedoc_example

[brichet]

Looks ready, but to try it in the built documentation of the PR, the src path of the iframe must be change from src=/lite/lab to src=lite/lab (removing the first slash).
I assume (and hope) it only occurs on the documentation generated for a PR.

To test the git puller feature, this link can be used https://litegitpuller--8.org.readthedocs.build/en/8/?repo=https%3A%2F%2Fgithub.com%2Fbrichet%2Ftesting-repo&urlpath=tree%2Ftesting-repo%2Fnotebooks%2Fsimple.ipynb&branch=main, but the first slash of the iframe src need to be removed in the html source.

[jtpio]

Normally we should be able to avoid using a Makefile, to make things simpler.

[jtpio]

For example we could follow the voici setup and use hatch scripts: https://github.com/voila-dashboards/voici/blob/1587e7bfa2a87b71be568a20e385dd9d8da6e2ae/pyproject.toml#L135-L140

[brichet]

Thanks, I updated the PR.
Can you explain when this additional hatch script for documentation is triggered ?
As far as I understand readthedoc build the documentation itself for PRs and branch.

[brichet]

@jtpio does the RTD preview action is usually working on voici https://github.com/voila-dashboards/voici/blob/1587e7bfa2a87b71be568a20e385dd9d8da6e2ae/.github/workflows/rtd-preview.yml ?
It does not work on the current opened PR, neither on some closed I tried.

[jtpio]

Yes, for example: voila-dashboards/voici#89 (comment)

But the workflow would first have to be merged and available on main.

[brichet]

the src path of the iframe must be change from src=/lite/lab to src=lite/lab (removing the first slash)

This is caused by jupyterlite/jupyterlite-sphinx#108.
I'll open a PR to fix it.

[brichet]

Yes, for example: voila-dashboards/voici#89 (comment)

The badge is visible but it leads me to a 404.

[brichet]

the src path of the iframe must be change from src=/lite/lab to src=lite/lab (removing the first slash)

This is caused by jupyterlite/jupyterlite-sphinx#108.
I'll open a PR to fix it.

Fixed in jupyterlite-sphinx

[jtpio]

Thanks!

[jtpio]

We can double check the Check Links job passes correctly on CI once merged into main.