Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 30, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a59722c
Update .rst file
Julfried Mar 29, 2025
84b0b93
Merge remote-tracking branch 'origin/main' into fix-docs
Pierre-Sassoulas Mar 29, 2025
c6c06c5
Test if it works better when using tox in CI
Pierre-Sassoulas Mar 29, 2025
d65b249
Merge remote-tracking branch 'origin/main' into fix-docs
Pierre-Sassoulas Mar 30, 2025
da7d696
Remove the pre-commit hook for doc generation
Pierre-Sassoulas Mar 30, 2025
dc4dfe8
[doc] Simplify the doc on how to build documentation
Pierre-Sassoulas Mar 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .github/workflows/checks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 || {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we sure this is correct? Wouldn't this always exit 1?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If tox -e docs is true this exit with 0

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; \
}
7 changes: 0 additions & 7 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 4 additions & 6 deletions doc/development_guide/contributor_guide/contribute.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?
----------------------------------
Expand Down
4 changes: 0 additions & 4 deletions doc/development_guide/contributor_guide/tests/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------

Expand Down
2 changes: 1 addition & 1 deletion doc/user_guide/configuration/all-options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``

Expand Down