Feature/issue 9 #29
Merged
Feature/issue 9 #29
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
frankinspace
force-pushed
the
feature/issue-9
branch
from
95f9994 to
f9e9ecb
Compare
frankinspace
approved these changes
Nov 9, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Github Issue: #9
Description
Create API documentation describing endpoints, parameters, and other useful info about how to run Hydrocron
Overview of work done
Create docs/ using jupyter-book (distro of sphinx). Include overview of Hydrocron, description of timeseries endpoint, links to additional SWOT info, etc.
Overview of verification done
Only static pages added, no new functionality. All existing unit tests pass.
Overview of integration done
Related to #28 to integrate with github actions. I will need someone's help to create the actual integration with Github Pages as I cannot access the project settings on this repo.
PR checklist:
See Pull Request Review Checklist for pointers on reviewing this pull request