Merge branch 'master' into bot/pull-translations

sphinx-doc · Mar 23, 2024 · d5131be · d5131be
2 parents 7ad2b1c + 4b3c4ab
commit d5131be
Show file tree

Hide file tree

Showing 464 changed files with 25,996 additions and 21,737 deletions.
diff --git a/.flake8 b/.flake8
@@ -2,8 +2,10 @@
 max-line-length = 95
 ignore =
     E116,
+    E203,
     E241,
     E251,
+    E501,
     E741,
     W503,
     W504,
@@ -22,10 +24,10 @@ exclude =
     .git,
     .tox,
     .venv,
+    venv,
+    node_modules/*,
     tests/roots/*,
     build/*,
     doc/_build/*,
     sphinx/search/*,
     doc/usage/extensions/example*.py,
-per-file-ignores =
-    tests/*: E501
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -293,3 +293,7 @@ f4c8a0a68e0013808d169357c9f77ebdf19d0f4e
 
 # Change 'isort' profile
 a13cf2c24dd16b37670ee1d359f511cbdfa4402d
+
+
+# 2024 copyright year update
+569fde84d49c984282355c768c16426af83132e2
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -1,6 +1,6 @@
 name: Bug report
 description: Something is not working correctly.
-labels: "bug"
+labels: "type:bug"
 
 body:
   - type: textarea

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: '<short description for the feature>'
-labels: 'enhancement'
+labels: 'type:proposal'
 assignees: ''
 
 ---

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -3,4 +3,8 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
+      interval: "daily"
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
diff --git a/.github/workflows/builddoc.yml b/.github/workflows/builddoc.yml
@@ -22,7 +22,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Install graphviz
@@ -35,8 +35,8 @@ jobs:
       run: >
         sphinx-build
         -M html ./doc ./build/sphinx
-        -T
-        -W
-        --jobs=auto
         -vv
+        --jobs=auto
+        --show-traceback
+        --fail-on-warning
         --keep-going
diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml
@@ -19,7 +19,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3"
           cache: pip
@@ -35,7 +35,7 @@ jobs:
 
       - name: Mint PyPI API token
         id: mint-token
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           # language=JavaScript
           script: |
@@ -78,12 +78,12 @@ jobs:
       - uses: actions/checkout@v4
       - name: Get release version
         id: get_version
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: core.setOutput('version', context.ref.replace("refs/tags/v", ""))
 
       - name: Create GitHub release
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
         with:
           name: "Sphinx ${{ steps.get_version.outputs.version }}"

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -22,103 +22,78 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Install pip
       run: python -m pip install --upgrade pip
 
-    - name: Install known good Ruff
-      run: python -m pip install ruff==0.0.284
-    - name: Lint with known good Ruff
-      run: ruff . --format github
+    - name: Install Ruff
+      run: |
+          ruff_version=$(awk -F'[="]' '/\[project\.optional-dependencies\]/ {p=1} /ruff/ {if (p) print $4}' pyproject.toml)
+          python -m pip install "ruff==${ruff_version}"
+
+    - name: Lint with Ruff
+      run: ruff check . --output-format github
 
-    - name: Install latest Ruff
-      run: python -m pip install --upgrade ruff
-    - name: Lint with latest Ruff
-      continue-on-error: true
-      run: ruff . --format github
+    - name: Format with Ruff
+      run: ruff format . --diff
 
   flake8:
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install --upgrade "flake8>=3.5.0" "flake8-simplify"
+        python -m pip install --upgrade "flake8>=3.5.0"
     - name: Lint with flake8
       run: flake8 .
 
-  isort:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install --upgrade isort
-    - name: Lint with isort
-      run: isort --check-only --diff .
-
   mypy:
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install --upgrade "mypy>=0.990" docutils-stubs types-requests
+        python -m pip install ".[lint,test]"
     - name: Type check with mypy
-      run: mypy sphinx/
+      run: mypy
 
   docs-lint:
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         python -m pip install --upgrade sphinx-lint
     - name: Lint documentation with sphinx-lint
-      run: >
-        sphinx-lint
-        --enable line-too-long
-        --max-line-length 85 
-        AUTHORS.rst
-        CHANGES.rst
-        CODE_OF_CONDUCT.rst
-        CONTRIBUTING.rst
-        README.rst
-        doc/
+      run: make doclinter
 
   twine:
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Install dependencies

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -35,30 +35,30 @@ jobs:
         - "3.9"
         - "3.10"
         - "3.11"
-        - "3.12-dev"
+        - "3.12"
         - "3.13-dev"
         docutils:
         - "0.18"
         - "0.20"
         include:
         # test every supported Docutils version for the latest supported Python
-        - python: "3.11"
+        - python: "3.12"
           docutils: "0.19"
 
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       if: "!endsWith(matrix.python, '-dev')"
       with:
         python-version: ${{ matrix.python }}
     - name: Set up Python ${{ matrix.python }} (deadsnakes)
-      uses: deadsnakes/action@v2.1.1
+      uses: deadsnakes/action@v3.1.0
       if: "endsWith(matrix.python, '-dev')"
       with:
         python-version: ${{ matrix.python }}
     - name: Check Python version
-      run: python --version
+      run: python --version --version
     - name: Install graphviz
       run: sudo apt-get install graphviz
     - name: Install dependencies
@@ -79,11 +79,11 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Check Python version
-      run: python --version
+      run: python --version --version
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -100,11 +100,11 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Check Python version
-      run: python --version
+      run: python --version --version
     - name: Install graphviz
       run: sudo apt-get install graphviz
     - name: Install dependencies
@@ -127,11 +127,11 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Check Python version
-      run: python --version
+      run: python --version --version
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -150,11 +150,11 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Check Python version
-      run: python --version
+      run: python --version --version
     - name: Install graphviz
       run: sudo apt-get install graphviz
     - name: Install dependencies
@@ -166,4 +166,4 @@ jobs:
       env:
         VIRTUALENV_SYSTEM_SITE_PACKAGES: "1"
     - name: codecov
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -34,7 +34,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Use Node.js ${{ env.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ env.node-version }}
         cache: "npm"

diff --git a/.github/workflows/transifex.yml b/.github/workflows/transifex.yml
@@ -17,7 +17,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Install transifex client
@@ -46,7 +46,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3"
     - name: Install transifex client
@@ -67,7 +67,7 @@ jobs:
     - name: Compile message catalogs
       run: python utils/babel_runner.py compile
     - name: Create Pull Request
-      uses: peter-evans/create-pull-request@v4
+      uses: peter-evans/create-pull-request@v6
       with:
         commit-message: "[internationalisation] Update translations"
         branch: bot/pull-translations

diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ TAGS
 .tox/
 .tx/
 .venv/
+venv/
 .coverage
 htmlcov
 .DS_Store