Dead links at PyPI

[bonimart]

Most of the links at the jupytext Project description page on PyPI lead to "Page Not Found".

Examples:

• https://pypi.org/project/jupytext/docs/formats-scripts.md#the-percent-format
• https://pypi.org/project/jupytext/docs/languages.md
• https://pypi.org/project/jupytext/docs/formats-markdown.md
• https://pypi.org/project/jupytext/docs/paired-notebooks.md
• https://pypi.org/project/jupytext/docs/config.md

[mwouts]

Oh yes you're right! It seems that I am asking to much from my README.md... The links work on GitHub and on RTD but that's right they don't work on PyPI.

@choldgraf or @mahendrapaipuri do you know if I can pre-process the README.md to e.g. add the full links to either GitHub or RTD when the package is being built?

[choldgraf]

hmmm, I'm not sure. You could define a template README.md (e.g. README.md.template) and auto-generate the README.md as a pre-commit hook or something if you really wanted control there. But that seems excessive

[mahendrapaipuri]

@mwouts I think you can include the absolute links instead of relative paths in README so that they work everywhere. Instead of something like:

A Python notebook encoded in the `py:percent` [format](docs/formats-scripts.md#the-percent-format)

using something like

A Python notebook encoded in the `py:percent` [format](https://github.com/mwouts/jupytext/blob/main/docs/formats-scripts.md#the-percent-format)

What do you think?