Skip to content

consolidate cirrus-ci documentation tasks #4219

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pp-mo merged 2 commits into from
Jul 5, 2021
Merged

consolidate cirrus-ci documentation tasks #4219

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28303fc
consolidate cirrus-ci documentation tasks
bjlittle Jul 1, 2021
c0780ef
review actions
bjlittle Jul 1, 2021
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
28 changes: 4 additions & 24 deletions .cirrus.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ env:
# Skip specific tasks by name. Set to a non-empty string to skip.
SKIP_LINT_TASK: ""
SKIP_TEST_TASK: ""
SKIP_GALLERY_TASK: ""
SKIP_DOCTEST_TASK: ""
SKIP_LINKCHECK_TASK: ""
# Skip task groups by type. Set to a non-empty string to skip.
Expand Down Expand Up @@ -154,26 +153,7 @@ test_task:


#
# Testing Documentation Gallery (Linux)
#
gallery_task:
only_if: ${SKIP_GALLERY_TASK} == "" && ${SKIP_ALL_DOC_TASKS} == ""
<< : *CREDITS_TEMPLATE
env:
PY_VER: 3.8
name: "${CIRRUS_OS}: py${PY_VER} doc tests (gallery)"
<< : *IRIS_TEST_DATA_TEMPLATE
<< : *LINUX_TASK_TEMPLATE
tests_script:
- export CONDA_OVERRIDE_LINUX="$(uname -r | cut -d'+' -f1)"
- echo "[Resources]" > ${SITE_CFG}
- echo "test_data_dir = ${IRIS_TEST_DATA_DIR}/test_data" >> ${SITE_CFG}
- echo "doc_dir = ${CIRRUS_WORKING_DIR}/docs" >> ${SITE_CFG}
- nox --session gallery -- --verbose


#
# Testing Documentation (Linux)
# Documentation Gallery and Testing (Linux)
#
doctest_task:
only_if: ${SKIP_DOCTEST_TASK} == "" && ${SKIP_ALL_DOC_TASKS} == ""
Expand All @@ -182,7 +162,7 @@ doctest_task:
PY_VER: 3.8
MPL_RC_DIR: ${HOME}/.config/matplotlib
MPL_RC_FILE: ${HOME}/.config/matplotlib/matplotlibrc
name: "${CIRRUS_OS}: py${PY_VER} doc tests"
name: "${CIRRUS_OS}: py${PY_VER} gallery and doctests"
<< : *IRIS_TEST_DATA_TEMPLATE
<< : *LINUX_TASK_TEMPLATE
tests_script:
Expand All @@ -197,7 +177,7 @@ doctest_task:


#
# Testing Documentation Link Check (Linux)
# Documentation Link Check (Linux)
#
linkcheck_task:
only_if: ${SKIP_LINKCHECK_TASK} == "" && ${SKIP_ALL_DOC_TASKS} == ""
Expand All @@ -206,7 +186,7 @@ linkcheck_task:
PY_VER: 3.8
MPL_RC_DIR: ${HOME}/.config/matplotlib
MPL_RC_FILE: ${HOME}/.config/matplotlib/matplotlibrc
name: "${CIRRUS_OS}: py${PY_VER} doc link check"
name: "${CIRRUS_OS}: py${PY_VER} link check"
<< : *LINUX_TASK_TEMPLATE
tests_script:
- export CONDA_OVERRIDE_LINUX="$(uname -r | cut -d'+' -f1)"
Expand Down
19 changes: 2 additions & 17 deletions noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,9 +198,9 @@ def tests(session: nox.sessions.Session):


@nox.session(python=PY_VER, venv_backend="conda")
def gallery(session: nox.sessions.Session):
def doctest(session: nox.sessions.Session):
"""
Perform iris gallery doc-tests.
Perform iris gallery and doc-tests.
Comment thread
bjlittle marked this conversation as resolved.
Outdated

Parameters
----------
Expand All @@ -216,21 +216,6 @@ def gallery(session: nox.sessions.Session):
"iris.tests.runner",
"--gallery-tests",
)


@nox.session(python=PY_VER, venv_backend="conda")
def doctest(session: nox.sessions.Session):
"""
Perform iris doc-tests.

Parameters
----------
session: object
A `nox.sessions.Session` object.

"""
prepare_venv(session)
session.install("--no-deps", "--editable", ".")
session.cd("docs")
session.run(
"make",
Expand Down