search

spglib / spgrep

On-the-fly generator of space-group irreducible representations
https://spglib.github.io/spgrep/
BSD 3-Clause "New" or "Revised" License
44 stars 5 forks source link

Update links to docs in README.md #156

Closed yardasol closed 2 months ago

yardasol commented 3 months ago

This PR changes the links in README.md to point to the appropriate webhosted doc page rather than the source file for that docpage in the repo.

lan496 commented 3 months ago

What is the benefit of replacing links to explicit URLs? The current relative paths work for both Sphinx docs and GitHub, but this PR looks to work only with Sphinx docs.

yardasol commented 2 months ago

Hi @lan496,

In the current README, a user browsing the GitHub repository will be redirected to the source markdown files which have limited functionality. Consider the case where I want to check out examples: I click on the respective link from the README and get redirected to this page which is not particularly useful as none of the Sphinx has been rendered there.

I understand now that this is the behavior because the README is also used as the landing page for the web-hosted docpages. Hardcoding these links in then is not the best solution.