From a59722ccf531823d7dd92f62ee0770154de1adff Mon Sep 17 00:00:00 2001 From: Julfried <51880314+Julfried@users.noreply.github.com> Date: Sat, 29 Mar 2025 10:45:38 +0100 Subject: [PATCH 1/4] Update .rst file --- doc/user_guide/configuration/all-options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user_guide/configuration/all-options.rst b/doc/user_guide/configuration/all-options.rst index 7a9cec81a6..82ade5b522 100644 --- a/doc/user_guide/configuration/all-options.rst +++ b/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`` From c6c06c5554079a2a649fa16f24a2aff20c67dd0f Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sat, 29 Mar 2025 20:34:47 +0100 Subject: [PATCH 2/4] Test if it works better when using tox in CI --- .github/workflows/checks.yaml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/checks.yaml b/.github/workflows/checks.yaml index cb0d57eb10..de1d8ddcdd 100644 --- a/.github/workflows/checks.yaml +++ b/.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; \ } From da7d69690137fbc60eb8018dfa5abee94fd6b072 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 30 Mar 2025 21:01:20 +0200 Subject: [PATCH 3/4] Remove the pre-commit hook for doc generation --- .pre-commit-config.yaml | 7 ------- doc/development_guide/contributor_guide/tests/install.rst | 4 ---- 2 files changed, 11 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3161cb5762..beb1b3527e 100644 --- a/.pre-commit-config.yaml +++ b/.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 diff --git a/doc/development_guide/contributor_guide/tests/install.rst b/doc/development_guide/contributor_guide/tests/install.rst index 83f7e1518c..a40b20500d 100644 --- a/doc/development_guide/contributor_guide/tests/install.rst +++ b/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 -------------------- From dc4dfe81cc9e7d7323e757da3f55c35995c23ff3 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 30 Mar 2025 21:08:22 +0200 Subject: [PATCH 4/4] [doc] Simplify the doc on how to build documentation build-html does not exists anymore. --- doc/development_guide/contributor_guide/contribute.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/development_guide/contributor_guide/contribute.rst b/doc/development_guide/contributor_guide/contribute.rst index 5746768fad..ade926612a 100644 --- a/doc/development_guide/contributor_guide/contribute.rst +++ b/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 ? ----------------------------------