Removal of 'Edit on Github' link for API pages of KQC documentation - Fixes #92 #93
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ISSUE
The API documentation pages are automatically generated by sphinx. Despite not having a documentation "source" the same way hand-written documentation pages have, sphinx still renders a link to the associated non-existent repo page.
Such link has to be removed only for the API-related documentation pages.
SOLUTION
Added docs/_templates/breadcrumbs.html, as suggested in this post, in order to overwrite the custom sphinx theme.
Changes:
Whenever
:github_url: hide
metadata is added at the top of a .rst file, breadcrumbs are not rendered.:github_url: hide
has been added to the top of each template file responsible for the generation of the API docs.A new line has been forced by adding
{{"\n"}}
to avoid the added static text interfering with header generation.Fixes #92