Drop doc build tester

Merge pull request #1145 from openfisca/drop-make-test-doc

Author: bonjourmauko

.github/workflows/workflow.yml

@@ -120,36 +120,6 @@ jobs:
       - name: Check NumPy typing against latest 3 minor versions
         run: for i in {1..3}; do VERSION=$(${GITHUB_WORKSPACE}/.github/get-numpy-version.py prev) && pip install numpy==$VERSION && make check-types; done
 
-  test-docs:
-    runs-on: ubuntu-latest
-    needs: [ build ]
-    env:
-      TERM: xterm-256color
-    steps:
-      - uses: actions/checkout@v2
-      - name: Checkout docs
-        run: make test-doc-checkout branch=${GITHUB_REF#refs/heads/}
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.7.12
-      - name: Cache build
-        id: restore-build
-        uses: actions/cache@v2
-        with:
-          path: ${{ env.pythonLocation }}
-          key: build-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}-${{ github.sha }}
-      - name: Cache docs
-        id: restore-docs
-        uses: actions/cache@v2
-        with:
-          path: ${{ env.pythonLocation }}
-          key: docs-${{ env.pythonLocation }}-${{ hashFiles('doc/requirements.txt') }}--${{ github.sha }}
-      - name: Install dependencies
-        run: make test-doc-install
-      - name: Run doc tests
-        run: make test-doc-build
-
   lint-files:
     runs-on: ubuntu-latest
     needs: [ build ]
@@ -174,7 +144,7 @@ jobs:
 
   check-version:
     runs-on: ubuntu-latest
-    needs: [ test-core, test-country-template, test-extension-template, check-numpy, test-docs, lint-files ] # Last job to run
+    needs: [ test-core, test-country-template, test-extension-template, check-numpy, lint-files ] # Last job to run
     steps:
       - uses: actions/checkout@v2
         with:

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+### 35.8.6 [#1145](https://github.com/openfisca/openfisca-core/pull/1145)
+
+#### Technical changes
+
+- Removes the automatic documentation build check
+  - It has been proven difficult to maintain, specifically due _dependency hell_ and a very contrived build workflow.
+
 ### 35.8.5 [#1137](https://github.com/openfisca/openfisca-core/pull/1137)
 
 #### Technical changes

Makefile

@@ -3,7 +3,6 @@ include openfisca_tasks/lint.mk
 include openfisca_tasks/publish.mk
 include openfisca_tasks/serve.mk
 include openfisca_tasks/test_code.mk
-include openfisca_tasks/test_doc.mk
 
 ## To share info with the user, but no action is needed.
 print_info = $$(tput setaf 6)[i]$$(tput sgr0)

README.md

@@ -135,70 +135,6 @@ OpenFisca’s toolchain checks whether documentation builds correctly and update
 
 In the meantime, please take a look at our [contributing guidelines](CONTRIBUTING.md) for some general tips on how to document your contributions, and at our official documentation's [repository](https://github.com/openfisca/openfisca-doc/blob/master/README.md) to in case you want to know how to build it by yourself —and improve it!
 
-### To verify that the documentation still builds correctly
-
-You can run:
-
-```sh
-make test-doc
-```
-
-### If it doesn't, or if the doc is already broken.
-
-Here's how you can fix it:
-
-1. Clone the documentation, if not yet done:
-
-```
-make test-doc-checkout
-```
-
-2. Install the documentation's dependencies, if not yet done:
-
-```
-make test-doc-install
-```
-
-3. Create a branch, both in core and in the doc, to correct the problems:
-
-```
-git checkout -b fix-doc
-sh -c "cd doc && git checkout -b `git branch --show-current`"
-```
-
-4. Fix the offending problems —they could be in core, in the doc, or both.
-
-You can test-drive your fixes by checking that each change works as expected:
-
-```
-make test-doc-build branch=`git branch --show-current`
-```
-
-5. Commit at each step, so you don't accidentally lose your progress:
-
-```
-git add -A && git commit -m "Fix outdated argument for Entity"
-sh -c "cd doc && git add -A && git commit -m \"Fix outdated argument for Entity\""
-```
-
-6. Once you're done, push your changes and cleanup:
-
-```
-git push origin `git branch --show-current`
-sh -c "cd doc && git push origin `git branch --show-current`"
-rm -rf doc
-```
-
-7. Finally, open a pull request both in [core](https://github.com/openfisca/openfisca-core/compare/master...fix-doc) and in the [doc](https://github.com/openfisca/openfisca-doc/compare/master...fix-doc).
-
-Continuous integration will automatically try to build the documentation from the same branch in both core and the doc (in our example "fix-doc") so we can integrate first our changes to Core, and then our changes to the doc.
-
-If no changes were needed to the doc, then your changes to core will be verified against the production version of the doc.
-
-If your changes concern only the doc, please take a look at the doc's [README](https://github.com/openfisca/openfisca-doc/blob/master/README.md).
-
-That's it! 🙌
-
 ## Serving the API
 
 OpenFisca-Core provides a Web-API. It is by default served on the `5000` port.

openfisca_tasks/install.mk

@@ -2,7 +2,7 @@
 install:
 	@$(call print_help,$@:)
 	@pip install --upgrade pip twine wheel
-	@pip install --editable ".[dev]" --upgrade --use-deprecated=legacy-resolver
+	@pip install --editable ".[dev]" --upgrade
 
 ## Uninstall project dependencies.
 uninstall:

openfisca_tasks/test_doc.mk

@@ -42,12 +42,13 @@
     'mypy == 0.910',
     'openfisca-country-template >= 3.10.0, < 4.0.0',
     'openfisca-extension-template >= 1.2.0rc0, < 2.0.0',
+    'pycodestyle >= 2.8.0, < 2.9.0',
     'pylint == 2.10.2',
     ] + api_requirements
 
 setup(
     name = 'OpenFisca-Core',
-    version = '35.8.5',
+    version = '35.8.6',
     author = 'OpenFisca Team',
     author_email = 'contact@openfisca.org',
     classifiers = [