Skip to content

Remove previous Pages deployment and update docs links - #499

Merged
MagnusSletten merged 3 commits into
NMRLipids:mainfrom
MagnusSletten:remove-doc-workflow
May 23, 2026
Merged

Remove previous Pages deployment and update docs links#499
MagnusSletten merged 3 commits into
NMRLipids:mainfrom
MagnusSletten:remove-doc-workflow

Conversation

@MagnusSletten

@MagnusSletten MagnusSletten commented May 21, 2026

Copy link
Copy Markdown
Collaborator

Removes the old github pages documentation deployment workflow and updates documentation links to Read the Docs.

  • Uses RTD stable for stable documentation links
  • Uses RTD latest for latest documentation links

One small question: should the main README documentation link and the pyproject.toml documentation URL point to the stable RTD docs or to latest?

I used the RTD root for the general documentation link, since stable is now the default. But maybe latest is better for links from the main branch, since it corresponds to the current code.

Related to #498

Another PR will take care of the github-pages branch redirects.


📚 Documentation preview 📚: https://databank--499.org.readthedocs.build/

@comcon1 comcon1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Do you know if RTD will automatically rebuild latest? I suppose it does it now but I don't understand who is triggering him.

@MagnusSletten

MagnusSletten commented May 22, 2026

Copy link
Copy Markdown
Collaborator Author

Looks good. Do you know if RTD will automatically rebuild latest? I suppose it does it now but I don't understand who is triggering him.

I think RTD rebuilds are handled through the github integration, where latest tracks the main branch and stable tracks the release/stable version configured in RTD. It uses webhooks.

There is one other issue we should think a bit more about which is deeper links. With the current redirect setup, only top-level links to /latest/ and /stable/ will redirect, but deeper links like /latest/schemas/... will not.

I can add a 404.html fallback redirect that maps those deeper old GitHub Pages links to the corresponding RTD paths, or we would need to fix links more broadly in other repositories/pages. Long-term it's better to have all those links changed for SEO purposes anyways.

@MagnusSletten

Copy link
Copy Markdown
Collaborator Author
/              -> https://databank.readthedocs.io/
/latest/       -> https://databank.readthedocs.io/latest/
/stable/       -> https://databank.readthedocs.io/stable/
/latest/anything     -> https://databank.readthedocs.io/
/stable/anything     -> https://databank.readthedocs.io/

This sound alright @comcon1 ? Rewriting the URL to map old sublinks is not hard but probably not worth it long-term. I can do a quick sweep of the nmrlipids organization and just add PRs to change the links wherever it's needed,

@comcon1

comcon1 commented May 23, 2026

Copy link
Copy Markdown
Member

This sound alright @comcon1 ? Rewriting the URL to map old sublinks is not hard but probably not worth it long-term. I can do a quick sweep of the nmrlipids organization and just add PRs to change the links wherever it's needed,

Yes, thank you very much!
I think, for now, redirect is enough. If you do 'sed' command in the two main repositories + website repository, it should be perfectly enough for us to go.

@MagnusSletten

Copy link
Copy Markdown
Collaborator Author

I think, for now, redirect is enough. If you do 'sed' command in the two main repositories + website repository, it should be perfectly enough for us to go.

Upload portal, bilayerdata, and this repo is done. Then the main website has a PR.

I think we can safely merge this PR as it just updates links + removes the old workflow.

@MagnusSletten
MagnusSletten merged commit 88ba4a3 into NMRLipids:main May 23, 2026
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants