Links on pypi.org are broken

[dagardner-nv]

The anchor links are non-functional, and the links to the tests/examples directory goto a 404 (https://pypi.org/project/rapids-dependency-file-generator/tests/examples/)

[jameslamb]

Thanks for taking the time to open this @dagardner-nv . You're totally right... the README we have today was designed to be used locally and in the GitHub GUI, and all those broken links are not a great experience on the PyPI homepage for the project.

That's something we'd like to work on at some point across RAPIDS: rapidsai/build-planning#70

I think the right fix here would probably be a mix of the following:

• move information intended for developers modifying the project (like the test link you mentioned) into CONTRIBUTING.md
• remove the manually-created table-of-contents (with all those anchor links) or make it work on PyPI.org
  • GitHub has a built-in table-of-contents for README files in its GUI, so we could probably just remove the manual one
• other editorial changes to make the README suitable for PyPI

I'd be happy to review a PR if you'd like to make one. Otherwise, we can leave this issue here to track the work and someone will pick it up when they have interest/time.