From 47d1831cd8db472652376f3a74bca7b5f8a3a95d Mon Sep 17 00:00:00 2001 From: David Buchmann Date: Wed, 15 Sep 2021 09:09:00 +0200 Subject: [PATCH 1/3] update readthedocs setup and dependencies --- .readthedocs.yaml | 13 +++++++++++++ Pipfile | 10 +++++----- conf.py | 9 ++++----- requirements.txt | 8 ++++---- 4 files changed, 26 insertions(+), 14 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..530f402 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +sphinx: + configuration: conf.py + +# additional formats +formats: + - pdf + +python: + version: "3.7" + install: + - requirements: requirements.txt diff --git a/Pipfile b/Pipfile index d597a31..bca311f 100644 --- a/Pipfile +++ b/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" diff --git a/conf.py b/conf.py index 3d27b70..c7fde6f 100644 --- a/conf.py +++ b/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 """ - - diff --git a/requirements.txt b/requirements.txt index 7a01cd2..f9bca84 100644 --- a/requirements.txt +++ b/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 From db8943363a98b03c48a894a89cef87d83f6b3768 Mon Sep 17 00:00:00 2001 From: David Buchmann Date: Sat, 18 Sep 2021 15:04:29 +0200 Subject: [PATCH 2/3] move spellcheck to github action --- .github/workflows/spellcheck.yml | 26 ++++++++++++++++++++++++++ .travis.yml | 21 --------------------- Makefile | 2 +- 3 files changed, 27 insertions(+), 22 deletions(-) create mode 100644 .github/workflows/spellcheck.yml delete mode 100644 .travis.yml diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..463d83f --- /dev/null +++ b/.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 diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 646ca58..0000000 --- a/.travis.yml +++ /dev/null @@ -1,21 +0,0 @@ -sudo: false - -language: python - -matrix: - include: - - python: 3.7 - dist: xenial - sudo: true - -addons: - apt_packages: - - enchant - -install: - - pip install pipenv - - pipenv install - -script: - - make SPHINXOPTS='-nW' html - - make spelling diff --git a/Makefile b/Makefile index f62a4e6..d0268ab 100644 --- a/Makefile +++ b/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 From 8021a2938c24c9cccb236c63f760c6569a93764f Mon Sep 17 00:00:00 2001 From: David Buchmann Date: Sat, 18 Sep 2021 15:30:43 +0200 Subject: [PATCH 3/3] drop mention of puli as it is dead --- httplug/backwards-compatibility.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/httplug/backwards-compatibility.rst b/httplug/backwards-compatibility.rst index 566c5cc..8f44574 100644 --- a/httplug/backwards-compatibility.rst +++ b/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.