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 links in docs when viewed in browser #1102

Merged
merged 4 commits into from
Jul 19, 2022

Conversation

adamjhawley
Copy link
Contributor

Fixes #1101 - broken links in documentation when viewed from a browser.

Initial commits:

  • Correct link pointing to non-existant section
  • Fix broken links in browser - Pipeline
  • Fix broken links in browser - Plotting Pitfalls
  • Fix broken links in browser - Grids

@ianthomas23
Copy link
Member

@adamjhawley Thanks for doing this. One of the discrepancies you identified was that we had an "Embedded" heading but it linked to a "Moving On" section. You have made them the same by using "Moving On" throughout, but I would rather it went the other way to be "Embedded" throughout. The other headings in the Pipeline section are technical and single word, and I think "Embedded" is more consistent.

Would you be willing to switch back to using "Embedded"? If so, it will be ready to merge.

Even though some Jupyter notebook readers will handle these links fine, they do
not work when transformed to HTML and rendered in browsers.

This patch fixes them so that they can be used in the browser too.

Partially-fixes: holoviz#1101

Signed-off-by: adamjhawley <[email protected]>
Even though some Jupyter notebook readers will handle these links fine, they do
not work when transformed to HTML and rendered in browsers.

This patch fixes them so that they can be used in the browser too.

Fixes: holoviz#1101

Signed-off-by: adamjhawley <[email protected]>
Even though some Jupyter notebook readers will handle these links fine, they do
not work when transformed to HTML and rendered in browsers.

This patch fixes them so that they can be used in the browser too.

Signed-off-by: adamjhawley <[email protected]>
@adamjhawley
Copy link
Contributor Author

Thanks for your feedback @ianthomas23. I've amended the relevant commit.

You mentioned "Embedded" but the original link was to "Embedding" so I opted for the latter. Happy to change to "Embedded" if you would prefer though.

Copy link
Member

@ianthomas23 ianthomas23 left a comment

Choose a reason for hiding this comment

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

Thanks @adamjhawley.

@ianthomas23 ianthomas23 merged commit ee76f2b into holoviz:master Jul 19, 2022
@adamjhawley adamjhawley deleted the pull-docs-links branch July 19, 2022 10:08
@jbednar
Copy link
Member

jbednar commented Jul 29, 2022

Thanks!

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.

Broken links in docs in tables of contents (Pipeline.html & Plotting_Pitfalls.html)
3 participants