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

Readme links not working in mesa/examples directory. #2527

Closed
Sahil-Chhoker opened this issue Dec 3, 2024 · 2 comments
Closed

Readme links not working in mesa/examples directory. #2527

Sahil-Chhoker opened this issue Dec 3, 2024 · 2 comments

Comments

@Sahil-Chhoker
Copy link
Contributor

Describe the bug
None of the example links work in ReadMe, they just take you to a non-existent page.

Expected behavior
They should link to the actual examples.

To Reproduce
Go to : ReadMe and click any kind of example.

@EwoutH
Copy link
Member

EwoutH commented Dec 3, 2024

Yeah this is a known problem. See #2448.

To make this work, I had to slightly change the links in the example headers. They don't work anymore on GitHub, but do work on RTD. I think this is a worthwhile tradeoff. If you read the readme on github, you have the file explorere at the top of the page anyway. I tested six or so versions of the links but none worked for both.

If you find a solution that works for both that would be great, but not sure if there is one.

@Sahil-Chhoker
Copy link
Contributor Author

Thanks @EwoutH for clarifying, I will see what I can do.

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 a pull request may close this issue.

2 participants