Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
"Edit on GitHub" fails when docs are in a different repo (git submodules) #1802
which points to: https://github.com/debops/docs/blob/master/docs/debops/docs/getting-started.rst
Repository which holds all the git submodules: https://github.com/debops/docs
Is there a way to fix the URL?
Related to: debops/docs#91
referenced this issue
Jul 27, 2018
I was able to replicate this https://rtd-test-submodule.readthedocs.io/en/latest/, but as I mentioned, there is no way for rtd to guess what submodule each page belong to (in an easy way at least). A way of avoiding broken links could be hiding the links https://docs.readthedocs.io/en/latest/guides/remove-edit-buttons.html
Or you could change the github links in the template instead of hiding it https://github.com/rtfd/sphinx_rtd_theme/blob/4a3d790e61d7524baac698badee814cd286b1219/sphinx_rtd_theme/breadcrumbs.html#L37-L68. For the rtd footer, there isn't a way to change the links (well, probably it can be done with js).
Anyway, I think this should be handled by github, with a redirection. I'm changing this to a feature, isn't a bug.