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

Fix broken docs links #1362

Merged
merged 1 commit into from
Jan 19, 2024
Merged

Conversation

coruscating
Copy link
Collaborator

Qiskit 0.45.2 removed all tutorials, so intersphinx linking no longer works and breaks the docs build. This PR updates Qiskit tutorial links to 1XP pages that give the corresponding information and also fixes a broken internal link.

Copy link
Collaborator

@wshanks wshanks left a comment

Choose a reason for hiding this comment

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

Looks good! "IBM Quantum Documentation's introductory guides" just links to IBM Quantum Documentation so maybe the link should just be on that part but it is clear enough.

@wshanks wshanks added this pull request to the merge queue Jan 19, 2024
@coruscating
Copy link
Collaborator Author

@wshanks Oh yeah, that would probably be clearer. I was also trying to figure out if there's a way to just link to the "Start/Build/Transpile/Verify/Run" series of pages without including the API reference and tutorials, which are more advanced than the old intro tutorials. @Eric-Arellano is there a page for just these introductory guides (are these guides?) or what would be a clear way to refer to them from external docs?

Merged via the queue into qiskit-community:main with commit bf980b4 Jan 19, 2024
11 checks passed
@Eric-Arellano
Copy link
Contributor

I was also trying to figure out if there's a way to just link to the "Start/Build/Transpile/Verify/Run" series of pages without including the API reference and tutorials, which are more advanced than the old intro tutorials

I'm not sure I follow. You could link to each individual index page like /start and /transpile? But in general the home page is probably best. I would assume your average user knows they don't need to read the API docs cover-to-cover.

It's good you only say "familiarity with" to make it clear they don't need to have deeply read every single docs page.

@coruscating coruscating deleted the fix-docs-links branch January 20, 2024 11:17
@coruscating
Copy link
Collaborator Author

@Eric-Arellano Yeah, I was just wondering if there's another portal on 1XP that only has the introductory series since I thought linking to the pages individually would be too fussy. I'll just continue to link to the home page then.

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.

3 participants