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

Fixes Broken Links In Mesa Documentation #2099

Closed
wants to merge 4 commits into from

Conversation

knightwayne
Copy link

Fixes #2098
I have also added a link for Mesa Overview on the main page. I am not sure if the replaced links needs to be jupyter notebook links or something else? Do let me know!

@knightwayne knightwayne mentioned this pull request Apr 2, 2024
@EwoutH EwoutH requested a review from rht April 2, 2024 14:21
@EwoutH EwoutH added the docs Release notes label label Apr 2, 2024
@rht
Copy link
Contributor

rht commented Apr 2, 2024

The index.md is meant to be used to render https://mesa.readthedocs.io/en/stable/, and if you check the links there, they work.

@knightwayne
Copy link
Author

The links at the top bar do work, but I was refering to links in the main page, here in the highlighted section, for Mesa Introductory Tutorial, and Mesa Visualization Tutorial. I think the files in the tutorial got updated from .html to .ipynb and I guess that's causing this issue.
I checked the issue is for both the latest and stable version of docs.

My question is do we replace it with the .ipynb files in the tutorial subfolder? Or will this cause some rendering issue(from .ipynb to html, I don't know if that's possible)? Do let me know, thanks!

@rht
Copy link
Contributor

rht commented Apr 4, 2024

but I was refering to links in the main page, here in the highlighted section, for Mesa Introductory Tutorial, and Mesa Visualization Tutorial. I think the files in the tutorial got updated from .html to .ipynb and I guess that's causing this issue.

I see, they are indeed broken. But they shouldn't be replaced by a link to GitHub. The end result should be the links go to working pages in Read the Docs.

@EwoutH
Copy link
Member

EwoutH commented Apr 17, 2024

@knightwayne are you willing to work further on this, so that the links work in RTD such as @rht suggested?

@knightwayne
Copy link
Author

Hi, sorry it slipped out of my mind, but sure, I will look into this and submit a fix by tonight!

@knightwayne
Copy link
Author

PR #2100 should fix this and supercedes the changes made here.

@tpike3
Copy link
Member

tpike3 commented May 5, 2024

Superseded by #2100 per @knightwayne

@tpike3 tpike3 closed this May 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken Links in Mesa Documentation
4 participants