Skip to content

Commit 211899e

Browse files
committed
fix documentation build
1 parent 466dd92 commit 211899e

File tree

5 files changed

+49
-2
lines changed

5 files changed

+49
-2
lines changed

.github/workflows/.editorconfig

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[*.yml]
2+
indent_size = 2

.github/workflows/spellcheck.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Spellcheck
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v2
16+
- name: Set up Python
17+
uses: actions/setup-python@v1
18+
with:
19+
python-version: 3.7
20+
- name: Install dependencies
21+
run: |
22+
python -m pip install --upgrade setuptools
23+
python -m pip install -r Resources/doc/requirements.txt
24+
- name: Run spell check
25+
run: |
26+
make -C Resources/doc/ spelling
27+
if [[ -s "Resources/doc/_build/spelling/output.txt" ]]; then echo "\nSpelling errors found\n" && cat "Resources/doc/_build/spelling/output.txt"; fi
28+
- name: Spellcheck
29+
run: |
30+
if [[ -s "Resources/doc/_build/spelling/output.txt" ]]; then cat "Resources/doc/_build/spelling/output.txt"; fi
31+
if [[ -s "Resources/doc/_build/spelling/output.txt" ]]; then false; fi

.readthedocs.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
3+
sphinx:
4+
configuration: Resources/doc/conf.py
5+
6+
# additional formats
7+
formats:
8+
- pdf
9+
10+
python:
11+
version: "3.7"
12+
install:
13+
- requirements: Resources/doc/requirements.txt

Resources/doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555

5656
# General information about the project.
5757
project = 'FOSHttpCacheBundle'
58-
copyright = '2014-2018, David de Boer, David Buchmann'
58+
copyright = 'David de Boer, David Buchmann'
5959

6060
# The version info for the project you're documenting, acts as replacement for
6161
# |version| and |release|, also used in various other places throughout the

Resources/doc/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
sphinx==1.8.5
12
git+https://github.com/fabpot/sphinx-php.git
2-
sphinx_rtd_theme
3+
sphinx-rtd-theme
34
sphinxcontrib-spelling
45
sphinxcontrib-phpdomain
56
pyenchant

0 commit comments

Comments
 (0)