get API docs hosted via GitHub pages #132
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
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.
this should fix #128
The thing that made this a bit of a headache is that GitHub pages and ReadTheDocs both operate out of the docs/ directory, so before I had them stomping on one another, and it didn't seem like there was a good way to configure where they should look.
This PR mostly just moves around existing things. The build output for the API docs now lives directly in the docs/ directory. It makes it a bit messy and sorta hides the RTD source (source dir), but this should work. I tested out this kind of setup on a simplified test repo of my own and it appeared to work out okay.
The changes for this won't show up on RTD or GitHub Pages until pushed to master, since the builds for those are only configured on push to master. Once this is merged into master, will need to play around with the repo settings a little to get it working, I think. Will also need to verify that RTD still builds correctly. Finally, once everything is verified okay, I'll update the RTD docs to point to the correct place for the API documentation.