<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/python-packages/sphinx-git.git/tests, branch dependabot/github_actions/peter-evans/create-pull-request-5</title>
<subtitle>github.com: sphinx-doc/sphinx.git
</subtitle>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/'/>
<entry>
<title>Support and prefer ``.jinja`` to ``_t`` for static templates (#11165)</title>
<updated>2023-04-07T17:07:15+00:00</updated>
<author>
<name>James Addison</name>
<email>55152140+jayaddison@users.noreply.github.com</email>
</author>
<published>2023-04-07T17:07:15+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=5d13215b58f93c6be8255ef2e3e20836508c7d47'/>
<id>5d13215b58f93c6be8255ef2e3e20836508c7d47</id>
<content type='text'>
Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;</pre>
</div>
</content>
</entry>
<entry>
<title>Disable localisation when ``SOURCE_DATE_EPOCH`` is set (#10949)</title>
<updated>2023-04-07T16:49:36+00:00</updated>
<author>
<name>James Addison</name>
<email>55152140+jayaddison@users.noreply.github.com</email>
</author>
<published>2023-04-07T16:49:36+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=f82c3c99126e644125d243ba0d0788197401e416'/>
<id>f82c3c99126e644125d243ba0d0788197401e416</id>
<content type='text'>
This commit disables Sphinx's localisation features when reproducible
builds are requested, as determined by a non-empty SOURCE_DATE_EPOCH_
environment variable.

The `Reproducible Builds`_ project aims to provide confidence to
consumers of packaged software that the artefacts they're downloading
and installing have not been altered by the environment they were
built in, and can be replicated at a later date if required.

Builds of localised documentation using Sphinx currently account for
a large category of reproducible build testing failures, because the
builders intentionally use varying environment locales at build-time.
This can affect the contents of the ``objects.inv`` file.

During investigation, it turned out that many ``gettext``-localised
values (particularly in Python modules under ``sphinx.domains``) were
being translated at module-load-time and would not subsequently be
re-localised.

This creates two unusual effects:

1. Attempting to write a test case to build the same application in
   two different languages was not initially possible, as the
   first-loaded translation catalogue (as found in the 
   ``sphinx.locale.translators`` global variable) would remain in-use
   for subsequent application builds under different locales.

2. Localisation of strings could vary depending on whether the
   relevant modules were loaded before or after the resource
   catalogues were populated.

We fix this by performing all translations lazily so that module
imports can occur in any order and localisation of inventory entries
should occur only when translations of those items are requested.

Localisation can then be disabled by configuring the ``gettext``
language to the ISO-639-3 'undetermined' code (``'und'``), as this
should not have an associated translation catalogue. We also want to
prevent ``gettext`` from  attempting to determine the host's locale
from environment variables (including ``LANGUAGE``).

.. _SOURCE_DATE_EPOCH: https://reproducible-builds.org/docs/source-date-epoch/
.. _Reproducible Builds: https://www.reproducible-builds.org/</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
This commit disables Sphinx's localisation features when reproducible
builds are requested, as determined by a non-empty SOURCE_DATE_EPOCH_
environment variable.

The `Reproducible Builds`_ project aims to provide confidence to
consumers of packaged software that the artefacts they're downloading
and installing have not been altered by the environment they were
built in, and can be replicated at a later date if required.

Builds of localised documentation using Sphinx currently account for
a large category of reproducible build testing failures, because the
builders intentionally use varying environment locales at build-time.
This can affect the contents of the ``objects.inv`` file.

During investigation, it turned out that many ``gettext``-localised
values (particularly in Python modules under ``sphinx.domains``) were
being translated at module-load-time and would not subsequently be
re-localised.

This creates two unusual effects:

1. Attempting to write a test case to build the same application in
   two different languages was not initially possible, as the
   first-loaded translation catalogue (as found in the 
   ``sphinx.locale.translators`` global variable) would remain in-use
   for subsequent application builds under different locales.

2. Localisation of strings could vary depending on whether the
   relevant modules were loaded before or after the resource
   catalogues were populated.

We fix this by performing all translations lazily so that module
imports can occur in any order and localisation of inventory entries
should occur only when translations of those items are requested.

Localisation can then be disabled by configuring the ``gettext``
language to the ISO-639-3 'undetermined' code (``'und'``), as this
should not have an associated translation catalogue. We also want to
prevent ``gettext`` from  attempting to determine the host's locale
from environment variables (including ``LANGUAGE``).

.. _SOURCE_DATE_EPOCH: https://reproducible-builds.org/docs/source-date-epoch/
.. _Reproducible Builds: https://www.reproducible-builds.org/</pre>
</div>
</content>
</entry>
<entry>
<title>autosummary: Support documenting inherited attributes (#10691)</title>
<updated>2023-04-06T22:33:43+00:00</updated>
<author>
<name>Jens Hedegaard Nielsen</name>
<email>Jens.Nielsen@microsoft.com</email>
</author>
<published>2023-04-06T22:33:43+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=3edae689040301e0b0833bb0321f265784874ff5'/>
<id>3edae689040301e0b0833bb0321f265784874ff5</id>
<content type='text'>
The current implementation of ``import_ivar_by_name`` filters
attributes if the name of the object that the attribute belongs to
does not match the object being documented. However, for inherited
attributes this is not the case. Filtering only on the attribute name
seems to resolve the issue. It is not clear to me if there are any
unwanted sideeffects of this and we should filter on the list of
qualnames for the object and all its super classes (if any).

Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
The current implementation of ``import_ivar_by_name`` filters
attributes if the name of the object that the attribute belongs to
does not match the object being documented. However, for inherited
attributes this is not the case. Filtering only on the attribute name
seems to resolve the issue. It is not clear to me if there are any
unwanted sideeffects of this and we should filter on the list of
qualnames for the object and all its super classes (if any).

Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;</pre>
</div>
</content>
</entry>
<entry>
<title>Enable 'nit-picky mode' for Sphinx's documentation</title>
<updated>2023-04-06T22:11:39+00:00</updated>
<author>
<name>Adam Turner</name>
<email>9087854+aa-turner@users.noreply.github.com</email>
</author>
<published>2023-04-06T22:11:39+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=7ecf0372809825b97082a73587b3c27660db01a7'/>
<id>7ecf0372809825b97082a73587b3c27660db01a7</id>
<content type='text'>
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
</pre>
</div>
</content>
</entry>
<entry>
<title>Support type comments in ``PropertyDocumenter`` (#11298)</title>
<updated>2023-04-06T21:56:17+00:00</updated>
<author>
<name>picnixz</name>
<email>10796600+picnixz@users.noreply.github.com</email>
</author>
<published>2023-04-06T21:56:17+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=aba392d87f5b7cc9954aa2666805a80cd593b2eb'/>
<id>aba392d87f5b7cc9954aa2666805a80cd593b2eb</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Fix instability in ``test_ext_viewcode`` (#11297)</title>
<updated>2023-04-06T21:40:33+00:00</updated>
<author>
<name>Martin Liška</name>
<email>mliska@suse.cz</email>
</author>
<published>2023-04-06T21:40:33+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=c1c2d758c9b54b5ecdc6eb14043f19fcf1caf6df'/>
<id>c1c2d758c9b54b5ecdc6eb14043f19fcf1caf6df</id>
<content type='text'>
Use ``freshenv`` argument and remove ``outdir`` for one test
as the previous one can leave an unexpected leftover.</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Use ``freshenv`` argument and remove ``outdir`` for one test
as the previous one can leave an unexpected leftover.</pre>
</div>
</content>
</entry>
<entry>
<title>Fix instability in ``test_build_epub`` (#11296)</title>
<updated>2023-04-06T21:33:20+00:00</updated>
<author>
<name>Martin Liška</name>
<email>mliska@suse.cz</email>
</author>
<published>2023-04-06T21:33:20+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=f25a36d0563b1beda3d2bad76e1b10dac4471512'/>
<id>f25a36d0563b1beda3d2bad76e1b10dac4471512</id>
<content type='text'>
Some tests need ``app.builder.build_all`` in order to have complete rebuild.</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Some tests need ``app.builder.build_all`` in order to have complete rebuild.</pre>
</div>
</content>
</entry>
<entry>
<title>Use a shared file-system lock in ``create_server`` (#11294)</title>
<updated>2023-04-06T21:24:49+00:00</updated>
<author>
<name>Martin Liška</name>
<email>mliska@suse.cz</email>
</author>
<published>2023-04-06T21:24:49+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=a80e3fd3771038f6bd1069a6f5d18b13398b1faa'/>
<id>a80e3fd3771038f6bd1069a6f5d18b13398b1faa</id>
<content type='text'>
With parallel run of tests, one gets "Address already in use" errors
as all tests attempt to bind to the same port. Fix it with a shared
file-system lock.

Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
With parallel run of tests, one gets "Address already in use" errors
as all tests attempt to bind to the same port. Fix it with a shared
file-system lock.

Co-authored-by: Adam Turner &lt;9087854+AA-Turner@users.noreply.github.com&gt;</pre>
</div>
</content>
</entry>
<entry>
<title>Autosummary: Extend ``__all__`` members to template rendering (#10811)</title>
<updated>2023-04-05T23:02:37+00:00</updated>
<author>
<name>Clément Pinard</name>
<email>clempinard@gmail.com</email>
</author>
<published>2023-04-05T23:02:37+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=9299003d40c775150c53366dcfdd4d944d0da1af'/>
<id>9299003d40c775150c53366dcfdd4d944d0da1af</id>
<content type='text'>
When ``False``, the ``autosummary_ignore_module_all`` option adds
members to the module's members entry that will be used for autodoc,
but otherwise ignores it. As such, if a class is available in the 
``__all__``, it won't be generated.

This commit aims to extend the ``__all__`` handling not only to
members, but also to corresponding attribute types (function,
classes, exceptions, modules)

The ``imported_members`` option is set to ``True`` if the object has
an ``__all__`` member and ``autosummary_ignore_module_all`` is ``False``</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
When ``False``, the ``autosummary_ignore_module_all`` option adds
members to the module's members entry that will be used for autodoc,
but otherwise ignores it. As such, if a class is available in the 
``__all__``, it won't be generated.

This commit aims to extend the ``__all__`` handling not only to
members, but also to corresponding attribute types (function,
classes, exceptions, modules)

The ``imported_members`` option is set to ``True`` if the object has
an ``__all__`` member and ``autosummary_ignore_module_all`` is ``False``</pre>
</div>
</content>
</entry>
<entry>
<title>Resolve lint errors from Ruff 0.0.261</title>
<updated>2023-04-05T13:19:43+00:00</updated>
<author>
<name>Adam Turner</name>
<email>9087854+aa-turner@users.noreply.github.com</email>
</author>
<published>2023-04-05T13:18:31+00:00</published>
<link rel='alternate' type='text/html' href='http://git.baserock.org/cgit/delta/python-packages/sphinx-git.git/commit/?id=52a099b7ec9b08aa034c05c515d7ba5e6f7b004c'/>
<id>52a099b7ec9b08aa034c05c515d7ba5e6f7b004c</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
</feed>
