mesa icon indicating copy to clipboard operation
mesa copied to clipboard

Fixes Broken Links In Mesa Documentation

Open knightwayne opened this issue 1 year ago • 6 comments

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 avatar Apr 02 '24 12:04 knightwayne

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.

rht avatar Apr 02 '24 22:04 rht

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!

knightwayne avatar Apr 03 '24 09:04 knightwayne

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.

rht avatar Apr 04 '24 01:04 rht

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

EwoutH avatar Apr 17 '24 12:04 EwoutH

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

knightwayne avatar Apr 17 '24 16:04 knightwayne

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

knightwayne avatar Apr 23 '24 01:04 knightwayne

Superseded by #2100 per @knightwayne

tpike3 avatar May 05 '24 11:05 tpike3