Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readthedocs/API #111

Merged
merged 54 commits into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
9548c8b
Add dependencies used in WSI
Mar 22, 2024
91dd748
Merge branch '24-repo-structure' into 105-readthedocsapi
Mar 22, 2024
b273bca
Create API reference
Mar 22, 2024
b3072dd
Merge branch 'main' into 105-readthedocsapi
Mar 25, 2024
9e02bc7
Update mathjax
barneydobson Mar 25, 2024
a93bcf2
Update logging.py
barneydobson Mar 26, 2024
5b8828c
Merge branch 'main' into 105-readthedocsapi
barneydobson Mar 26, 2024
8404783
Merge branch '24-repo-structure' into 105-readthedocsapi
barneydobson Mar 26, 2024
623984a
Begin quickstart
barneydobson Mar 26, 2024
501ee42
Merge branch 'main' into 105-readthedocsapi
Apr 8, 2024
7f531be
Merge branch '75-if-calculating-nse-for-two-timeseries-also-do-kge-an…
Apr 8, 2024
c7b36cb
fix linting
Apr 8, 2024
0b44cd0
Update experimenter.py
Apr 8, 2024
49e3eda
Merge branch '75-if-calculating-nse-for-two-timeseries-also-do-kge-an…
Apr 8, 2024
2caa99e
remove doctest
Apr 8, 2024
0cd7118
Merge branch '75-if-calculating-nse-for-two-timeseries-also-do-kge-an…
Apr 9, 2024
599e17a
Merge branch 'sensitivity_analysis' into 105-readthedocsapi
Apr 9, 2024
06c4a9f
Update swmmanywhere.py
Apr 9, 2024
101df5b
Update quickstart.py
Apr 9, 2024
da40ecd
Merge branch 'sensitivity_analysis' into 105-readthedocsapi
Apr 10, 2024
398a720
minimal viable quickstart
Apr 11, 2024
34640ed
Merge branch 'main' into 105-readthedocsapi
Apr 11, 2024
415b4ec
Update publish.yml
Apr 22, 2024
5c5ad49
Update metric_utilities.py
Apr 22, 2024
c2b0e35
Merge branch 'main' into 105-readthedocsapi
Apr 25, 2024
7b80941
Update graph_utilities.py
Apr 25, 2024
0d0cc63
Merge branch 'main' into 105-readthedocsapi
Apr 28, 2024
22b101c
Merge branch 'main' into 105-readthedocsapi
Jun 12, 2024
59a3d30
Update figure and fix merge
Jun 12, 2024
14ee7cf
update equation in relerror
Jun 12, 2024
ff298c2
Update demo_config.yml
Jun 12, 2024
a179340
Update swmmanywhere.py
Jun 12, 2024
826c441
Update mkdocs.yml
Jun 12, 2024
0e5ccd3
Fix merge from main
Jun 12, 2024
0e1c82d
Update swmmanywhere.py
Jun 12, 2024
a4d686c
Update docs/notebooks/quickstart.py
barneydobson Jun 17, 2024
e3c11ce
Merge branch 'main' into 105-readthedocsapi
Jun 18, 2024
966a9c7
Update quickstart.py
Jun 18, 2024
3ab4678
move demo to defs
Jun 20, 2024
2de9574
Update .gitignore
Jun 20, 2024
73eee70
update minimal reqs
Jun 21, 2024
5118a18
Create quickstart.md
Jun 21, 2024
f6ee540
Merge branch 'main' into 105-readthedocsapi
Jun 21, 2024
bede753
Update to run with minimal config
Jun 21, 2024
e439467
Delete quickstart.py
Jun 21, 2024
42fdd64
Update metric_utilities.py
Jun 21, 2024
f1b0af1
Update pyproject.toml
Jun 21, 2024
844442a
switch backup subbasin method
Jun 21, 2024
678c736
Update docstring
Jun 21, 2024
e95dc36
make snap the default subbasin method
Jun 21, 2024
775ff5b
fix logging doctest error
Jun 24, 2024
4c6d654
Update pyproject.toml
Jun 24, 2024
c0ecd32
Update index.md
Jun 24, 2024
ed3d8b7
Update quickstart.md
Jun 24, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ jobs:
test:
uses: ./.github/workflows/ci.yml

publish-docs:
needs: publish-PyPI
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Install dependencies
run: pip install -r doc-requirements.txt

- name: Deploy Docs
run: mkdocs gh-deploy --force

# publish:
# runs-on: ubuntu-latest
# needs: test
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,6 @@ dmypy.json

# Pysheds cache
cache/

# Documentation generated models
swmmanywhere_models/
Loading