Skip to content

chore: crosslink from the 0.21.x -> 1.0 docs#185

Merged
CalMacCQ merged 1 commit into
guppylang_v0.21.xfrom
cm/crosslink_to_v1
Jul 16, 2026
Merged

chore: crosslink from the 0.21.x -> 1.0 docs#185
CalMacCQ merged 1 commit into
guppylang_v0.21.xfrom
cm/crosslink_to_v1

Conversation

@CalMacCQ

@CalMacCQ CalMacCQ commented Jul 16, 2026

Copy link
Copy Markdown
Collaborator

Crosslinking to the v1 preview docs so people can navigate to the v1 docs from docs.quantinuum.com/guppy (currently showing 0.21.16).

Screenshot 2026-07-16 at 12 26 17

I think this is better as an "external link" rather than a crossreference as we have two sphinx sites which we build one at a time. If wer make a crossreference we will get sphinx warnings and the link checker will also complain.

I can also make a PR into main linking to the v0.x docs

@CalMacCQ
CalMacCQ requested a review from sburton84 July 16, 2026 11:29
Comment thread sphinx/index.md
guppylang/guppylang/CHANGELOG.md
migration_guide.md
faqs.md
Guppy v1 preview docs <https://docs.quantinuum.com/guppy-v1.x/getting_started.html>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is it possible to use a relative URL, i.e. just /guppy-v1.x/getting_started.html instead of including the docs.quantinuum.com? Otherwise even on the staging/testing deployments the URL will continue to point to the v1 docs on the production site.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Ah I didn't think of that. Good point. Let me check.

@CalMacCQ CalMacCQ Jul 16, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I don't think a relative link in the TOC will work here. Basically Sphinx treats this as a non-existing document and doesn't render the sidebar entry

WARNING: toctree contains reference to nonexisting document 'guppy-v1.x/getting_started' [toc.not_readable

We could maybe create a dummy v1_preview.md file with a redirect if need be? I believe sphinx allows you to write a raw html directive

https://stackoverflow.com/questions/50565770/how-to-embed-html-or-xml-in-restructuredtext-sphinx-so-the-browser-can-render

This could be annoying as IDK if we could test it locally.

@CalMacCQ CalMacCQ Jul 16, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Another alternative would be to do a sed replace on the html for staging (changing the absolute url) after we've built the pages. Definetly a hack though.

@CalMacCQ
CalMacCQ merged commit 123c6af into guppylang_v0.21.x Jul 16, 2026
2 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