search

GeoStat-Framework / GSTools

GSTools - A geostatistical toolbox: random fields, variogram estimation, covariance models, kriging and much more
https://geostat-framework.org
GNU Lesser General Public License v3.0
544 stars 71 forks source link

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

Closed LSchueler closed 1 month ago

LSchueler commented 1 month ago

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

MuellerSeb commented 1 month ago

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 commented 1 month ago

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

MuellerSeb commented 1 month ago

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 commented 1 month ago

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.