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?

[mwouts]

Well, I need the relative links, as we do use this file in the documentation. I think I am looking for a build hook, maybe something like #1298 could work?

[mahendrapaipuri]

Ah, ok, I see. You are using the README in the sphinx docs as well.

In that case, may be a simple option would be to copy the README (with absolute links) file into docs folder before compiling sphinx. You can add it as a target into Sphinx Makefile. Something like:

copy-readme:
	@echo "Copying top level README file"
	cp ../README.md README.md
        sed -i 's:https://github.com/mwouts/jupytext/blob/main/::g' README.md

And make the above target as dependent to build target for Sphinx docs.