Merge branch '4.x' into 9427

Author: tk0miya

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,94 @@
+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: |
+        <Paste your command-line here which cause the problem>
+        ```
+        $ 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/bug_report.md

@@ -0,0 +1,19 @@
+name: 'Lock old threads'
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/lock-threads@v2
+        with:
+          github-token: ${{ github.token }}
+          issue-lock-inactive-days: '30'
+          pr-lock-inactive-days: '30'

.github/workflows/lock.yml

@@ -23,9 +23,9 @@ jobs:
           python: 3.9
           docutils: du17
           coverage: "--cov ./ --cov-append --cov-config setup.cfg"
-        # - name: py310-dev
-        #   python: 3.10-dev
-        #   docutils: du16
+        - name: py310-dev
+          python: 3.10-dev
+          docutils: du17
     env:
       PYTEST_ADDOPTS: ${{ matrix.coverage }}
 

.github/workflows/main.yml

@@ -0,0 +1,51 @@
+name: Sync translations on repository and transifex.com
+
+on:
+  schedule:
+  - cron: "0 0 * * SUN"
+  workflow_dispatch:
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: 4.x
+    - name: Set up Python
+      uses: actions/setup-python@v2
+    - name: Install dependencies
+      run:  pip install -U babel jinja2 transifex-client
+    - name: Extract translations from source code
+      run:  python setup.py extract_messages
+    - name: Push translations to transifex.com
+      run:  cd sphinx/locale && tx push -s --no-interactive --parallel
+      env:
+        TX_TOKEN: ${{ secrets.TX_TOKEN }}
+
+  pull:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: 4.x
+    - name: Set up Python
+      uses: actions/setup-python@v2
+    - name: Install dependencies
+      run:  pip install -U babel jinja2 transifex-client
+    - name: Extract translations from source code
+      run:  python setup.py extract_messages
+    - name: Pull translations to transifex.com
+      run:  cd sphinx/locale && tx pull -a -f --no-interactive --parallel
+      env:
+        TX_TOKEN: ${{ secrets.TX_TOKEN }}
+    - name: Compile message catalogs
+      run:  python setup.py compile_catalog
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v3
+      with:
+        commit-message: 'Update message catalogs'
+        branch: bot/pull-translations
+        title: Update message catalogs

.github/workflows/transifex.yml

@@ -1,3 +1,114 @@
+Release 4.1.0 (in development)
+==============================
+
+Dependencies
+------------
+
+* Support jinja2-3.0
+
+Incompatible changes
+--------------------
+
+Deprecated
+----------
+
+* The ``app`` argument of ``sphinx.environment.BuildEnvironment`` becomes
+  required
+* ``sphinx.application.Sphinx.html_theme``
+* ``sphinx.ext.autosummary._app``
+* ``sphinx.util.docstrings.extract_metadata()``
+
+Features added
+--------------
+
+* #8107: autodoc: Add ``class-doc-from`` option to :rst:dir:`autoclass`
+  directive to control the content of the specific class like
+  :confval:`autoclass_content`
+* #8588: autodoc: :confval:`autodoc_type_aliases` now supports dotted name. It
+  allows you to define an alias for a class with module name like
+  ``foo.bar.BazClass``
+* #9175: autodoc: Special member is not documented in the module
+* #9195: autodoc: The arguments of ``typing.Literal`` are wrongly rendered
+* #9185: autodoc: :confval:`autodoc_typehints` allows ``'both'`` setting to
+  allow typehints to be included both in the signature and description
+* #4257: autodoc: Add :confval:`autodoc_class_signature` to separate the class
+  entry and the definition of ``__init__()`` method
+* #8061, #9218: autodoc: Support variable comment for alias classes
+* #3014: autodoc: Add :event:`autodoc-process-bases` to modify the base classes
+  of the class definitions
+* #9272: autodoc: Render enum values for the default argument value better
+* #9384: autodoc: ``autodoc_typehints='none'`` now erases typehints for
+  variables, attributes and properties
+* #3257: autosummary: Support instance attributes for classes
+* #9358: html: Add "heading" role to the toctree items
+* #9129: html search: Show search summaries when html_copy_source = False
+* #9307: html search: Prevent corrections and completions in search field
+* #9120: html theme: Eliminate prompt characters of code-block from copyable
+  text
+* #9176: i18n: Emit a debug message if message catalog file not found under
+  :confval:`locale_dirs`
+* #9414: LaTeX: Add xeCJKVerbAddon to default fvset config for Chinese documents
+* #9016: linkcheck: Support checking anchors on github.com
+* #9016: linkcheck: Add a new event :event:`linkcheck-process-uri` to modify
+  URIs before checking hyperlinks
+* #6525: linkcheck: Add :confval:`linkcheck_allowed_redirects` to mark
+  hyperlinks that are redirected to expected URLs as "working"
+* #1874: py domain: Support union types using ``|`` in info-field-list
+* #9268: py domain: :confval:`python_use_unqualified_type_names` supports type
+  field in info-field-list
+* #9097: Optimize the parallel build
+* #9131: Add :confval:`nitpick_ignore_regex` to ignore nitpicky warnings using
+  regular expressions
+* #9174: Add ``Sphinx.set_html_assets_policy`` to tell extensions to include
+  HTML assets in all the pages. Extensions can check this via
+  ``Sphinx.registry.html_assets_policy``
+* C++, add support for
+
+  - ``inline`` variables,
+  - ``consteval`` functions,
+  - ``constinit`` variables,
+  - ``char8_t``,
+  - ``explicit(<constant expression>)`` specifier,
+  - digit separators in literals, and
+  - constraints in placeholder type specifiers, aka. adjective syntax
+    (e.g., ``Sortable auto &v``).
+
+* C, add support for digit separators in literals.
+* #9166: LaTeX: support containers in LaTeX output
+
+
+Bugs fixed
+----------
+
+* #8872: autodoc: stacked singledispatches are wrongly rendered
+* #8597: autodoc: a docsting having metadata only should be treated as
+  undocumented
+* #9185: autodoc: typehints for overloaded functions and methods are inaccurate
+* #9250: autodoc: The inherited method not having docstring is wrongly parsed
+* #9283: autodoc: autoattribute directive failed to generate document for an
+  attribute not having any comment
+* #9364: autodoc: single element tuple on the default argument value is wrongly
+  rendered
+* #9362: autodoc: AttributeError is raised on processing a subclass of Tuple[()]
+* #9317: html: Pushing left key causes visiting the next page at the first page
+* #9381: html: URL for html_favicon and html_log does not work
+* #9270: html theme : pyramid theme generates incorrect logo links
+* #9217: manpage: The name of manpage directory that is generated by
+  :confval:`man_make_section_directory` is not correct
+* #9350: manpage: Fix font isn't reset after keyword at the top of samp role
+* #9306: Linkcheck reports broken link when remote server closes the connection
+  on HEAD request
+* #9280: py domain: "exceptions" module is not displayed
+* #9319: quickstart: Make sphinx-quickstart exit when conf.py already exists
+* #9387: xml: XML Builder ignores custom visitors
+* #9224: ``:param:`` and ``:type:`` fields does not support a type containing
+  whitespace (ex. ``Dict[str, str]``)
+* #8945: when transforming typed fields, call the specified role instead of
+  making an single xref. For C and C++, use the ``expr`` role for typed fields.
+
+Testing
+--------
+
 Release 4.0.4 (in development)
 ==============================
 
@@ -519,7 +630,7 @@ Bugs fixed
 * #8567: autodoc: Instance attributes are incorrectly added to Parent class
 * #8566: autodoc: The ``autodoc-process-docstring`` event is emitted to the
   alias classes unexpectedly
-* #8583: autodoc: Unnecessary object comparision via ``__eq__`` method
+* #8583: autodoc: Unnecessary object comparison via ``__eq__`` method
 * #8565: linkcheck: Fix PriorityQueue crash when link tuples are not
   comparable
 
@@ -585,7 +696,7 @@ Bugs fixed
 * #8443: autodoc: autodata directive can't create document for PEP-526 based
   type annotated variables
 * #8443: autodoc: autoattribute directive can't create document for PEP-526
-  based uninitalized variables
+  based uninitialized variables
 * #8480: autodoc: autoattribute could not create document for __slots__
   attributes
 * #8503: autodoc: autoattribute could not create document for a GenericAlias as
@@ -742,7 +853,7 @@ Bugs fixed
 * #8091: autodoc: AttributeError is raised on documenting an attribute on Python
   3.5.2
 * #8099: autodoc: NameError is raised when target code uses ``TYPE_CHECKING``
-* C++, fix parsing of template template paramters, broken by the fix of #7944
+* C++, fix parsing of template template parameters, broken by the fix of #7944
 
 Release 3.2.0 (released Aug 08, 2020)
 =====================================
@@ -1031,7 +1142,7 @@ Bugs fixed
 * #3673: autodoc: member-order="bysource" does not work for a module having
   __all__
 * #7668: autodoc: wrong retann value is passed to a handler of
-  autodoc-proccess-signature
+  autodoc-process-signature
 * #7711: autodoc: fails with ValueError when processing numpy objects
 * #7791: autodoc: TypeError is raised on documenting singledispatch function
 * #7551: autosummary: a nested class is indexed as non-nested class
@@ -1237,7 +1348,7 @@ Features added
 * #6417: py domain: Allow to make a style for arguments of functions and methods
 * #7238, #7239: py domain: Emit a warning on describing a python object if the
   entry is already added as the same name
-* #7341: py domain: type annotations in singature are converted to cross refs
+* #7341: py domain: type annotations in signature are converted to cross refs
 * Support priority of event handlers. For more detail, see
   :py:meth:`.Sphinx.connect()`
 * #3077: Implement the scoping for :rst:dir:`productionlist` as indicated