123 fixed broken links on the docs site .... but broke the image links in the README.
I didn't realize that the top-level README.md was being symlinked into docs/source, and the changes I made to relative paths in that file don't work from the root of the repo.
This fixes that, by:
breaking that symlink, in favor of just copying README.md into docs/source when make -C docs html is run
modifying those relative paths so they work from the root of the repo
Notes for Reviewers
How I tested this
Tested the docs site by rebuilding and clicking around as described in #123.
123 fixed broken links on the docs site .... but broke the image links in the README.
I didn't realize that the top-level
README.md
was being symlinked intodocs/source
, and the changes I made to relative paths in that file don't work from the root of the repo.This fixes that, by:
README.md
intodocs/source
whenmake -C docs html
is runNotes for Reviewers
How I tested this
Tested the docs site by rebuilding and clicking around as described in #123.
You can see the README changes worked here: https://github.com/jameslamb/legate-boost/tree/docs/fix-readme