Fix #254 "Edit on Github" documentation links. #291
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
From [the RTD docs](https://read-the-docs.readthedocs.org/en/latest/builds.html#sphinx): > When you choose Sphinx as your Documentation Type...We will look inside > a doc or docs directory first, and then look within your entire project. My interpretation is that removing the /docs directory from the project root will cause RTD to search the entire project and find the nested directory.
|
To be clear: I don't really know if this will work. |
|
Cool. Let's see! |
ralphbean
added a commit
that referenced
this pull request
Mar 11, 2016
Fix #254 "Edit on Github" documentation links.
|
Woohoo! Vague documentation correctly interpreted! |
|
🎉 |
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.
From the RTD
docs:
My interpretation is that removing the /docs directory from the project
root will cause RTD to search the entire project and find the nested
directory.