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

Remove duplicate readme text from docs' index.rst #358

Closed
wants to merge 1 commit into from

Conversation

LSchueler
Copy link
Member

I just saw this in GSTools-Cython and had to try this out in GSTools. Duplicating the readme so many times was pretty annoying.

@LSchueler LSchueler added this to the 1.6 milestone Jul 15, 2024
@LSchueler LSchueler self-assigned this Jul 15, 2024
@LSchueler LSchueler requested a review from MuellerSeb July 15, 2024 14:37
@MuellerSeb
Copy link
Member

MuellerSeb commented Jul 16, 2024

I only didn't do this because the links to the tutorials are not correctly resolved if you don't look at the stable documentation. I didn't know how to resolve this. A cool thing would be to be able to replace strings (link prefixes) in the markdown file when including it in the rst file.

Maybe we just remove the references to the tutorials? Don't know.. Maybe the the MyST parser provides something. Used it in other projects to include markdown files in sphinx doc.

@MuellerSeb
Copy link
Member

MuellerSeb commented Jul 16, 2024

See here for myst config options: https://myst-parser.readthedocs.io/en/latest/configuration.html

@MuellerSeb
Copy link
Member

I think we could preprocess the readme in the conf.py file and simply remove the https://geostat-framework.readthedocs.io/projects/gstools/en/stable/ string in every place.

@LSchueler
Copy link
Member Author

I was just so excited, because at first glance, it looked as if this was working. I'll close this PR for now, as I think we both have enough other things to do at the moment.

@LSchueler LSchueler closed this Jul 18, 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.

2 participants