summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2021-02-25 12:35:46 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2021-02-26 22:12:25 +0100
commit9f125fce7971714333d23c7f554411342466721c (patch)
treeb4a2828e67cd960ebb8503157a32745c9894115e
parentacddbc57d9072d78a3e3ae56c6c9d28c7daab2d5 (diff)
downloaddjango-9f125fce7971714333d23c7f554411342466721c.tar.gz
Used GitHub actions for docs tests.
Co-Authored-By: Tom Forbes <tom@tomforb.es>
-rw-r--r--.github/workflows/docs.yml35
-rw-r--r--docs/conf.py4
-rw-r--r--docs/requirements.txt3
3 files changed, 41 insertions, 1 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000000..405b8c8686
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,35 @@
+name: Docs
+
+on:
+ pull_request:
+ paths:
+ - 'docs/**'
+ push:
+ branches:
+ - master
+ paths:
+ - 'docs/**'
+
+jobs:
+ docs:
+ runs-on: ubuntu-latest
+ name: docs
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.9
+ - name: Cache dependencies
+ uses: actions/cache@v2
+ with:
+ path: ~/.cache/pip
+ key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
+ restore-keys: |
+ ${{ runner.os }}-pip-
+ - run: python -m pip install -r docs/requirements.txt
+ - name: Build docs
+ run: |
+ cd docs
+ sphinx-build -b spelling -n -q -W --keep-going -d _build/doctrees -D language=en_US -j auto . _build/spelling
diff --git a/docs/conf.py b/docs/conf.py
index acad0b6d51..6665b50c8b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -61,6 +61,8 @@ spelling_lang = 'en_US'
# Location of word list.
spelling_word_list_filename = 'spelling_wordlist'
+spelling_warning = True
+
# Add any paths that contain templates here, relative to this directory.
# templates_path = []
@@ -125,7 +127,7 @@ today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = ['_build', '_theme']
+exclude_patterns = ['_build', '_theme', 'requirements.txt']
# The reST default role (used for this markup: `text`) to use for all documents.
default_role = "default-role-error"
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000000..e95ceeec27
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+pyenchant
+sphinx
+sphinxcontrib-spelling