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.

Sign up for GitHub

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

Add CI checks for docs building cleanly #294

Merged
merged 3 commits into from
Dec 8, 2020
Merged

Add CI checks for docs building cleanly #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a235ddd
configure CI to enforce docs build without warnings
Nov 30, 2020
76b14fe
configure CI to check for broken links in docs
Nov 30, 2020
c90c959
tweak link to avoid Sphinx linkcheck false positive
Dec 2, 2020
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
2 changes: 1 addition & 1 deletion docs/modeling-resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ NOTE: Our "beta" models have run for less than one full season. At this stage, e
Radio Frequency Interference Effects On SMOS
============================================

The attached document details the effect that Radio Frequency Interference (RFI) has on the soil moisture source `SMOS <https://app.gro-intelligence.com/#/dictionary/sources/43>`_: `radio-frequency-interference-smos.pdf <https://github.com/gro-intelligence/api-client/wiki/radio-frequency-interference-smos.pdf>`_
The attached document details the effect that Radio Frequency Interference (RFI) has on the soil moisture source `SMOS <https://app.gro-intelligence.com/dictionary/sources/43>`_: `radio-frequency-interference-smos.pdf <https://github.com/gro-intelligence/api-client/wiki/radio-frequency-interference-smos.pdf>`_

TRMM and GPM spatial extents
============================
Expand Down
7 changes: 6 additions & 1 deletion shippable.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,16 @@ build:
shippable_retry pip install -r api/client/samples/analogous_years/requirements.txt &&
poetry run pytest api/client/samples/analogous_years/
on_success:
# Ensure latest docs build without warnings or errors.
- >
shippable_retry poetry install -E docs &&
poetry run sphinx-build -W --keep-going docs docs/_build/html
# Check for broken links in the docs.
- poetry run sphinx-build -b linkcheck docs docs/_build/linkcheck
# Build docs and push to gh-pages.
# Note: git remote set-url is for setting a git url instead of an https
# one, which is needed so Shippable can be authenticated to push changes.
- >
shippable_retry poetry install -E docs &&
git config --global user.email "[email protected]" &&
git config --global user.name "Gro Intelligence" &&
git remote set-url origin [email protected]:$REPO_FULL_NAME.git &&
Expand Down