use github action for spellcheck

Author: dbu

.github/workflows/spellcheck.yml

@@ -0,0 +1,31 @@
+name: Spellcheck
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade setuptools
+          python -m pip install -r doc/requirements.txt
+      - name: Run spell check
+        run: |
+          make -C doc/ spelling
+          if [[ -s "doc/_build/spelling/output.txt" ]]; then echo "\nSpelling errors found\n" && cat "doc/_build/spelling/output.txt"; fi
+      - name: Spellcheck
+        run: |
+          if [[ -s "doc/_build/spelling/output.txt" ]]; then cat "doc/_build/spelling/output.txt"; fi
+          if [[ -s "doc/_build/spelling/output.txt" ]]; then false; fi

.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+sphinx:
+    configuration: conf.py
+
+# additional formats
+formats:
+    - pdf
+
+python:
+    version: "3.7"
+    install:
+        - requirements: doc/requirements.txt

.travis.yml

@@ -23,7 +23,6 @@ matrix:
     - php: 7.3
     - php: 7.4
       env: COVERAGE=true PHPUNIT_FLAGS="-v --coverage-text" VARNISH_MODULES_VERSION=0.12.1
-      #TODO re-add DOCCHECK=true - see https://github.com/FriendsOfSymfony/FOSHttpCache/pull/450
 
       # PHP 8.0 (Travis does not yet support using the stable 8.0.0)
     - php: nightly
@@ -76,17 +75,13 @@ before_script:
     cat /etc/apt/sources.list
     sudo apt-get update -qq
     sudo apt-get install -qq varnish
-  - if [ "$DOCCHECK" = true ]; then sudo apt-get install -qq python-sphinx enchant; fi
-  - if [ "$DOCCHECK" = true ]; then sudo pip install -r doc/requirements.txt; fi
   - if [ "$VARNISH_MODULES_VERSION" != "" ]; then sh ./tests/install-varnish-modules.sh; fi
   # Install NGINX
   - sh ./tests/install-nginx.sh
 
 script:
   - composer validate --strict --no-check-lock
   - vendor/bin/simple-phpunit $PHPUNIT_FLAGS
-  - if [[ "$DOCCHECK" = true ]]; then make -C doc SPHINXOPTS='-nW' html; fi
-  - if [[ "$DOCCHECK" = true ]]; then make -C doc spelling; fi
 
 after_script:
   - if [[ $COVERAGE = true ]]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi

doc/_static/tabs.css

@@ -25,7 +25,7 @@ div.configuration-block ul.simple li.selected a {
     color: white;
 }
 
-div.highlight-varnish3, div.highlight-varnish {
+div.highlight-varnish3, div.highlight-varnish4 {
     border: none !important;
 }
 

doc/conf.py

@@ -9,7 +9,7 @@
 
 lexers['php'] = PhpLexer(startinline=True, linenos=1)
 lexers['varnish3'] = CLexer()
-lexers['varnish'] = CLexer()
+lexers['varnish4'] = CLexer()
 
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 if not on_rtd:  # only import and set the theme if we're building docs locally
@@ -132,10 +132,14 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-def setup(app):
-    app.add_javascript('tabs.js')
-    app.add_stylesheet('tabs.css')
-    app.add_stylesheet('fos.css')
+html_js_files = [
+    'tabs.js',
+]
+
+html_css_files = [
+    'tabs.css',
+    'fos.css',
+]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -265,5 +269,5 @@ def setup(app):
 
 config_block = {
     'varnish3': 'Varnish 3',
-    'varnish': 'Varnish 4 & 5'
+    'varnish4': 'Varnish 4 & 5'
 }

doc/requirements.txt

@@ -1,3 +1,4 @@
+sphinx==1.8.5
 git+https://github.com/fabpot/sphinx-php.git
 sphinx-rtd-theme
 sphinxcontrib-spelling

doc/spelling_word_list.txt

@@ -3,6 +3,7 @@ backend
 cacheable
 config
 css
+Fastly
 hostname
 hostnames
 http

doc/varnish-configuration.rst

@@ -16,7 +16,7 @@ which IPs are allowed to issue invalidation requests. To use the provided
 configuration fragments, this ACL has to be named ``invalidators``. The most
 simple ACL, valid for all Varnish versions from 3 onwards, looks as follows:
 
-.. code-block:: varnish
+.. code-block:: varnish4
 
     # /etc/varnish/your_varnish.vcl
 
@@ -59,7 +59,7 @@ To enable this feature, add the following to ``your_varnish.vcl``:
 
 .. configuration-block::
 
-    .. code-block:: varnish
+    .. code-block:: varnish4
 
         include "path-to-config/varnish/fos_purge.vcl";
 
@@ -100,7 +100,7 @@ To enable this feature, add the following to ``your_varnish.vcl``:
 
 .. configuration-block::
 
-    .. code-block:: varnish
+    .. code-block:: varnish4
 
         include "path-to-config/varnish/fos_refresh.vcl";
 
@@ -129,7 +129,7 @@ To enable this feature, add the following to ``your_varnish.vcl``:
 
 .. configuration-block::
 
-    .. code-block:: varnish
+    .. code-block:: varnish4
 
         include "path-to-config/varnish/fos_ban.vcl";
 
@@ -211,7 +211,7 @@ and include ``resources/config/varnish/fos_tags_xkey.vcl`` in your VCL:
 
 .. configuration-block::
 
-    .. code-block:: varnish
+    .. code-block:: varnish4
 
         include "path-to-config/varnish/fos_tags_xkey.vcl";
 
@@ -242,7 +242,7 @@ look like this:
 .. configuration-block::
 
     .. literalinclude:: ../resources/config/varnish/fos_ban.vcl
-        :language: varnish
+        :language: varnish4
         :emphasize-lines: 17-23,50-51
         :linenos:
 
@@ -288,7 +288,7 @@ To enable this feature, add the following to ``your_varnish.vcl``:
 
 .. configuration-block::
 
-    .. code-block:: varnish
+    .. code-block:: varnish4
 
         include "path-to-config/varnish/fos_user_context.vcl";
         include "path-to-config/varnish/fos_user_context_url.vcl";
@@ -365,7 +365,7 @@ To make the hash request cacheable, you must extract a stable user session id
 *before* calling ``fos_user_context_recv``. You can do this as
 `explained in the Varnish documentation`_:
 
-.. code-block:: varnish
+.. code-block:: varnish4
     :linenos:
 
     sub vcl_recv {
@@ -397,7 +397,7 @@ Add the following to ``your_varnish.vcl``:
 
 .. configuration-block::
 
-    .. code-block:: varnish
+    .. code-block:: varnish4
 
         include "path-to-config/varnish/fos_custom_ttl.vcl";
 
@@ -438,7 +438,7 @@ To enable this feature, add the following to ``your_varnish.vcl``:
 
 .. configuration-block::
 
-    .. code-block:: varnish
+    .. code-block:: varnish4
 
         include "path-to-config/varnish/fos_debug.vcl";