Merge branch '5.x' into BK_viewdoc_linenos

.codecov.yml

@@ -1,3 +1,4 @@
+comment: false
 coverage:
   status:
     project:

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,93 @@
+name: Bug report
+description: Something is not working correctly.
+labels: "bug"
+
+body:
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: >-
+        A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How to Reproduce
+      description: Please provide steps to reproduce this bug.
+      value: |
+        ```
+        $ git clone https://github.com/.../some_project
+        $ cd some_project
+        $ pip install -r requirements.txt
+        $ cd docs
+        $ make html SPHINXOPTS="-D language=de"
+        $ # open _build/html/index and see bla bla
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: >-
+        A clear and concise description of what you expected to happen.
+
+  - type: input
+    attributes:
+      label: Your project
+      description: >-
+        Link to your sphinx project, or attach zipped small project sample.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Screenshots
+      description: >-
+        If applicable, add screenshots to help explain your problem.
+    validations:
+      required: false
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment info
+
+  - type: input
+    attributes:
+      label: OS
+      description: >-
+        [e.g. Unix/Linux/Mac/Win/other with version]
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Python version
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Sphinx version
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Sphinx extensions
+      description: >-
+        [e.g. sphinx.ext.autodoc, recommonmark]
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: Extra tools
+      description: >-
+        [e.g. Browser, tex or something else]
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: >-
+        Add any other context about the problem here.
+        [e.g. URL or Ticket]

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,9 @@
+# Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+blank_issues_enabled: false  # default: true
+contact_links:
+- name: Question
+  url: https://stackoverflow.com/questions/tagged/python-sphinx
+  about: For Q&A purpose, please use Stackoverflow with the tag python-sphinx
+- name: Discussion
+  url: https://groups.google.com/forum/#!forum/sphinx-users
+  about: For general discussion, please use sphinx-users mailing list.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,20 @@
 Subject: <short purpose of this pull request>
 
+<!--
+  Before posting a pull request, please choose a appropriate branch:
+
+  - Breaking changes: master
+  - Critical or severe bugs: X.Y.Z
+  - Others: X.Y
+
+  For more details, see https://www.sphinx-doc.org/en/master/internals/release-process.html#branch-model
+-->
+
 ### Feature or Bugfix
 <!-- please choose -->
 - Feature
 - Bugfix
+- Refactoring
 
 ### Purpose
 - <long purpose of this pull request>

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/builddoc.yml

@@ -0,0 +1,24 @@
+name: Build document
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3
+    - name: Install dependencies
+      run:  |
+        sudo apt update
+        sudo apt install -y graphviz
+        pip install -U tox
+    - name: Run Tox
+      run:  tox -e docs

.github/workflows/coverage.yml

@@ -0,0 +1,35 @@
+name: Coverage
+
+on: [push]
+
+permissions:
+  contents: read
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'sphinx-doc'
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3
+
+    - name: Check Python version
+      run: python --version
+
+    - name: Install graphviz
+      run: sudo apt-get install graphviz
+
+    - name: Install dependencies
+      run: python -m pip install -U pip tox pytest-cov
+
+    - name: Run Tox
+      run: tox --sitepackages -e py -- -vv
+      env:
+        PYTEST_ADDOPTS: "--cov ./ --cov-append --cov-config setup.cfg"
+
+    - name: codecov
+      uses: codecov/codecov-action@v3

.github/workflows/create-release.yml

@@ -0,0 +1,23 @@
+name: Create release
+
+on:
+  push:
+    tags:
+    - "v*.*.*"
+
+permissions:
+  contents: read
+
+jobs:
+  create-release:
+    permissions:
+      contents: write  # for softprops/action-gh-release to create GitHub release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          body: "Changelog: https://www.sphinx-doc.org/en/master/changes.html"

.github/workflows/docutils-latest.yml

@@ -0,0 +1,29 @@
+name: Test with the HEAD of docutils
+
+on:
+  schedule:
+  - cron: "0 0 * * SUN"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    if: github.repository_owner == 'sphinx-doc'
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3
+    - name: Check Python version
+      run: python --version
+    - name: Install graphviz
+      run: sudo apt-get install graphviz
+    - name: Install dependencies
+      run: pip install -U tox codecov
+    - name: Run Tox
+      run: tox -e du-latest -- -vv