-
-
Notifications
You must be signed in to change notification settings - Fork 488
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
Switch to GitHub Pages for hosting the documentation #777
Comments
In principle I'm perfectly fine with migrating to GitHub Pages. We don't need the multi-version support that RTD provides, and we also don't need a latest/stable split but can always just deploy the latest dev version of the docs. New features are rare and will anyway be marked with a Don't worry about the redirects either, we can quite easily set those up even with URL rewriting that would (for example) drop the
This is the key part, let's focus on that. I think it's a separate issue, one of the existing ones that deals with nightly wheels probably. I doubt we want to be in the business of hosting a whole distribution, since that doesn't scale very well. I'm still not 100% sure how the recent work by @Carreau et al. gets deployed to get us an up-to-date and working set of packages when loading JupyterLite inside the PyWavelets docs. |
I'm also in favor of trying to find a solution that would favor nightly wheels instead of building a whole distribution; It in general better for the ecosystem as it's more flexible and reusable across projects. I'll try to investigate how this ties into JupyterLite. I think we should also be able to build the wasm32 wheel on RTD as well if we don't want to go upload the wheel to the scientific Python nightly. |
We're already uploading the nightly wheels to https://anaconda.org/scientific-python-nightly-wheels/pywavelets and don't plan to stop, so I think we're fine in that respect. |
Oh, yeah, I missed that; then we shoudl just pull from there indeed. |
Meh, I there is a bug in micorpip that actually mark the wasm32 wheels as incompatible... |
Both of them are supposed to be the same platform actually – the rename from the Emscripten version to Pyodide + Year + build number in the platform tag was just to indicate that the built wheels are meant to work with the Pyodide distribution rather than purely wheels that are compiled with Emscripten/for WASM. |
It might be a bug, |
With JupyterLite, the way forward would be that we use https://jupyterlite.readthedocs.io/en/stable/howto/pyodide/packages.html#installing-packages-at-runtime to install the nightly wheels with a new piplite command (and maybe modify A custom Pyodide distribution with GitHub Pages would not scale very well, but should be fine for a package like PyWavelets. |
As stated in the issue title, I'd like to propose moving the hosted documentation away from Read the Docs and using GitHub Pages instead for hosting. This was last discussed in #706 (comment) and, probably, a few times elsewhere.
Some of the advantages and reasons for this suggestion are as follows:
.readthedocs.yaml
fileSome things to be thought about:
/en/stable/
and/en/latest/
respectively. Setting redirects for broken links is possible under the Read the Docs admin dashboard, but it's difficult to do the same thing on GitHub Pages.master
branch and uses a fine-grained PAT to update the rebuilt docs in the gh-pages branch for a PyWavelets/docs repositoryconf.py
file.The text was updated successfully, but these errors were encountered: