doc: Add workaround for Read The Docs #47
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RTD now wants an `index.html` file in the root. Otherwise RTD considers the docs broken. Our docs use `contents.html` as entry point. Our RTD configuration has page redirects in place: - `/` -> `/contents.html` - `/index.html` -> `/contents.html` Add a dummy `index.rst` to make RTD happy. The page is hidden in the TOC and just links to start of `contents.html` in the root. The trick ensures that references in 3rd party documentations and search machine indexes are kept happy. Signed-off-by: Christian Heimes <cheimes@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
RTD now wants an
index.htmlfile in the root. Our docs usecontents.htmlas entry point. Our RTD configuration has page redirects in place:/->/contents.html/index.html->/contents.htmlAdd a dummy
index.rstto make RTD happy. The page is hidden in the TOC and just links to start ofcontents.htmlin the root.