forked from python/cpython
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into decimal-logop-docs
- Loading branch information
Showing
1,027 changed files
with
35,396 additions
and
19,343 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
[run] | ||
branch = True | ||
|
||
[report] | ||
# Regexes for lines to exclude from consideration | ||
exclude_lines = | ||
# Don't complain if non-runnable code isn't run: | ||
if 0: | ||
if __name__ == .__main__.: | ||
|
||
.*# pragma: no cover | ||
.*# pragma: no branch | ||
|
||
# Additions for IDLE: | ||
.*# htest # | ||
if not (_htest or _utest): | ||
if not .*_utest: | ||
if .*_htest: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,39 +28,30 @@ jobs: | |
cache-dependency-path: 'Doc/requirements.txt' | ||
- name: 'Install build dependencies' | ||
run: make -C Doc/ venv | ||
- name: 'Check documentation' | ||
run: make -C Doc/ check | ||
- name: 'Build HTML documentation' | ||
run: make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html | ||
|
||
# Add pull request annotations for Sphinx nitpicks (missing references) | ||
# To annotate PRs with Sphinx nitpicks (missing references) | ||
- name: 'Get list of changed files' | ||
if: github.event_name == 'pull_request' | ||
id: changed_files | ||
uses: Ana06/[email protected] | ||
with: | ||
filter: "Doc/**" | ||
- name: 'Build changed files in nit-picky mode' | ||
if: github.event_name == 'pull_request' | ||
format: csv # works for paths with spaces | ||
- name: 'Build HTML documentation' | ||
continue-on-error: true | ||
run: | | ||
# Mark files the pull request modified | ||
touch ${{ steps.changed_files.outputs.added_modified }} | ||
# Build docs with the '-n' (nit-picky) option; convert warnings to annotations | ||
make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n --keep-going" html 2>&1 | | ||
python Doc/tools/warnings-to-gh-actions.py | ||
# Ensure some files always pass Sphinx nit-picky mode (no missing references) | ||
- name: 'Build known-good files in nit-picky mode' | ||
set -Eeuo pipefail | ||
# Build docs with the '-n' (nit-picky) option; write warnings to file | ||
make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going -w sphinx-warnings.txt" html | ||
- name: 'Check warnings' | ||
if: github.event_name == 'pull_request' | ||
run: | | ||
# Mark files that must pass nit-picky | ||
python Doc/tools/touch-clean-files.py | ||
# Build docs with the '-n' (nit-picky) option, convert warnings to errors (-W) | ||
make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going" html 2>&1 | ||
python Doc/tools/check-warnings.py \ | ||
--check-and-annotate '${{ steps.changed_files.outputs.added_modified }}' \ | ||
--fail-if-regression \ | ||
--fail-if-improved | ||
# This build doesn't use problem matchers or check annotations | ||
# It also does not run 'make check', as sphinx-lint is not installed into the | ||
# environment. | ||
build_doc_oldest_supported_sphinx: | ||
name: 'Docs (Oldest Sphinx)' | ||
runs-on: ubuntu-latest | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.