Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit 9f54743

Browse files
committed
ci: Run doctests
Signed-off-by: John Andersen <[email protected]>
1 parent c3eedcd commit 9f54743

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

.ci/run.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,9 @@ function run_docs() {
127127
"${PYTHON}" -m pip install --prefix=~/.local -U -e "${SRC_ROOT}[dev]"
128128
"${PYTHON}" -m dffml service dev install -user
129129

130+
# Doctests
131+
./scripts/doctest.sh
132+
130133
# Make master docs
131134
master_docs="$(mktemp -d)"
132135
TEMP_DIRS+=("${master_docs}")

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ examples/shouldi/response.json
2323
docs/plugins/service/http
2424
*pip-wheel-metadata/
2525
*.gz
26+
doctest/

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1515
are a list or a dict where the values are of the `spec` type. Rather than the
1616
list or dict itself being of the `spec` type.
1717
- Fixed the URL mentioned in example to configure a model.
18+
- Sphinx doctests are now run in the CI in the DOCS task.
1819
### Removed
1920
- Unused imports
2021

scripts/doctest.sh

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env sh
2+
set -e
3+
4+
rm -rf doctest
5+
python3.7 -c 'import os, pkg_resources; [e.load() for e in pkg_resources.iter_entry_points("console_scripts") if e.name.startswith("sphinx-build")][0]()' -b doctest docs doctest

0 commit comments

Comments
 (0)