Merge pull request #290 from php-http/update-sphinx

Update Pipfile

.github/workflows/spellcheck.yml

@@ -0,0 +1,26 @@
+name: spellcheck
+
+on: [push]
+
+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: |
+                  sudo apt update && sudo apt install -y enchant
+                  python -m pip install --upgrade setuptools
+                  python -m pip install --upgrade pyenchant sphinx-rtd-theme sphinxcontrib-spelling
+            - name: Check spelling
+                # show list of misspelled words
+              run: |
+                  make spelling
+                  if [[ -s "_build/spelling/output.txt" ]]; then cat "_build/spelling/output.txt"; fi
+                  if [[ -s "_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: requirements.txt

Makefile

@@ -2,7 +2,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = pipenv run sphinx-build
+SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build
 

Pipfile

@@ -7,11 +7,11 @@ verify_ssl = true
 
 [packages]
 sphinx-php = {git = "https://github.com/fabpot/sphinx-php.git"}
-sphinx-rtd-theme = "==0.1.6"
-sphinxcontrib-spelling = "==4.2.0"
-pyenchant = "~=2.0"
-docutils = "==0.12"
-Sphinx = "~=1.4.0"
+sphinx-rtd-theme = "==1.0.0"
+sphinxcontrib-spelling = "~=7.2.0"
+pyenchant = "~=3.2.1"
+docutils = "==0.17"
+Sphinx = "~=4.2.0"
 
 [requires]
 python_version = "3.7"

conf.py

@@ -157,9 +157,10 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-def setup(app):
-    app.add_stylesheet('custom.css')
-    app.add_stylesheet('highlight.css')
+html_css_files = [
+    'custom.css',
+    'highlight.css',
+]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -311,5 +312,3 @@ def setup(app):
 .. _Composer: https://getcomposer.org
 .. _HttplugBundle: https://github.com/php-http/HttplugBundle
 """
-
-

httplug/backwards-compatibility.rst

@@ -20,10 +20,7 @@ Discovery
 The order of the strategies is not part of our BC promise. The strategies themselves are marked
 as ``@internal`` so they are also not part of our BC promise.
 However, we do promise that we will not remove a strategy neither will we remove classes from the
-``CommonClassesStrategy``. We will also support the following Puli versions:
-
-* 1.0.0-beta9
-* 1.0.0-beta10
+``CommonClassesStrategy``.
 
 The consequences of the BC promise for the discovery library is that you can not rely on the *same* client to be
 returned in the future. However, if discovery does find a client now, you can be sure that after future updates it will still discover a client.

requirements.txt

@@ -1,6 +1,6 @@
 git+https://github.com/fabpot/sphinx-php.git#egg=sphinx-php
-sphinx~=1.4.0
-sphinx-rtd-theme==0.1.6
-sphinxcontrib-spelling==4.2.0
+sphinx~=4.2.0
+sphinx-rtd-theme==1.0.0
+sphinxcontrib-spelling~=7.2.0
 pyenchant
-docutils==0.12
+docutils==0.17