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 example README.md #2570

Closed
wants to merge 1 commit into from
Closed

Conversation

jackiekazil
Copy link
Member

Fix broken links.

@quaquel
Copy link
Member

quaquel commented Dec 28, 2024

This breaks the links on read the docs. See #2448 and #2528.

I don't know of a way to use the readme when generating the read the docs examples landing page and have links work both within github and within readthedocs.

@EwoutH
Copy link
Member

EwoutH commented Dec 28, 2024

This issue keeps coming back, so we should try to fix it somehow.

One thing that might work is move the Readme, for example by breaking the Readme into a Basic and Advanced section, so the relative links would be the same for GitHub and RTD.

@quaquel
Copy link
Member

quaquel commented Dec 28, 2024

This issue keeps coming back, so we should try to fix it somehow.

I agree

One thing that might work is move the Readme, for example by breaking the Readme into a Basic and Advanced section, so the relative links would be the same for GitHub and RTD.

That is not the problem. The issue is that readthedocs requires examples/basic/ect, while github uses basic/ect. So, one option is to just splice it the examples part when generating the readthedocs file. This could be done in docs/conf.py and then setup_examples_pages.

@jackiekazil
Copy link
Member Author

Shall I close this?

@quaquel quaquel closed this Dec 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants