Small Docs Updates #102
Merged
Small Docs Updates #102
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
|
Thanks a bunch for these updates. I haven't tried Pipfiles before (mainly because I didn't know how to use them) but this looks like a neat addition. Thanks! |
jason-neal
pushed a commit
to jason-neal/Starfish
that referenced
this pull request
Jan 2, 2019
Small Docs Updates
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.
Hello, I wanted to make some changes within the docs, mostly adding things. The biggest thing I've done is added the list of Instruments defined in
grid_tools.py. There were some minor tweaks on files here and there, everything should be trivial, but feel free to look at the diffs. In addition I've added Pipfiles. I use pipenv for my environment handling, but you may not want them. It was nice because I could specify sphinx as a dev package and make it easier for contributors to get up and running with them. Feel free to delete those files if you don't want to merge them, though. Make sure if you merge this to rebuild the docs and sync them to RTD. I noticed documentation that was in the code but isn't on the site, which is not good!