Fix caching issue that led to incorrect all-options.rst being merged on main (#10320)

Using tox works because tox does not use the cached venv from the github action.
It's not efficient but this is a fast fix. We removed the pre-commit hook for doc 
generation because it's too slow to be usable and we have already two ways to
generate the doc. Also "make build-html" does not exists anymore so upgraded the doc.

Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>

Author: Julfried

.github/workflows/checks.yaml

@@ -180,11 +180,10 @@ jobs:
       - name: Check documentation build and links
         run: |
           . venv/bin/activate
-          cd doc
-          pre-commit run --hook-stage push sphinx-generated-doc --all-files || {
+          tox -e docs || {
             echo "git diff:" ; \
             git diff ; \
             echo "End of 'git diff'" ; \
-            echo "Make sure that 'make html' succeed without any modifications locally." ; \
+            echo "Make sure that 'tox -e docs' succeed without any modifications locally." ; \
             exit 1; \
           }

.pre-commit-config.yaml

@@ -103,13 +103,6 @@ repos:
           ]
         exclude: tests(/\w*)*/functional/|tests/input|tests(/\w*)*data/|doc/
         stages: [manual]
-      - id: sphinx-generated-doc
-        alias: sphinx-generated-doc
-        name: sphinx-generated-doc
-        entry: make -C doc/ html
-        pass_filenames: false
-        language: system
-        stages: [pre-push]
       - id: check-newsfragments
         name: Check newsfragments
         entry: python3 -m script.check_newsfragments

doc/development_guide/contributor_guide/contribute.rst

@@ -125,14 +125,12 @@ Tips for Getting Started with Pylint Development
 Building the documentation
 ----------------------------
 
-You can use the makefile in the doc directory with ``make html`` to build the
-documentation. To test smaller changes you can consider ``build-html``, which skips some checks but will be faster::
+You can use the makefile in the doc directory to build the documentation::
 
-  $ cd doc
-  $ make install-dependencies
-  $ make html
+  $ make -C doc/ install-dependencies
+  $ make -C doc/ html
 
-We're reusing generated files for speed, use ``make clean`` when you want to start from scratch.
+We're reusing generated files for speed, use ``make clean`` or ``tox -e docs`` when you want to start from scratch.
 
 How to choose the target version ?
 ----------------------------------

doc/development_guide/contributor_guide/tests/install.rst

@@ -28,10 +28,6 @@ This ensures your testing environment is similar to Pylint's testing environment
 pre-commit hooks which should take care of the autoformatting for you before each
 commit. To enable it, run ``pre-commit install`` in the ``pylint`` root directory.
 
-**Even more optionally**: You can enable slow on push hooks with ``pre-commit install --install-hooks -t pre-push``.
-It will do slow checks like checking that the generated documentation is up to date
-before each push.
-
 Astroid installation
 --------------------
 

doc/user_guide/configuration/all-options.rst

@@ -1501,7 +1501,7 @@ Standard Checkers
 
 --missing-member-hint-distance
 """"""""""""""""""""""""""""""
-*The minimum edit distance a name should have in order to be considered a similar match for a missing member name.*
+*The maximum edit distance a name should have in order to be considered a similar match for a missing member name.*
 
 **Default:**  ``1``