summaryrefslogtreecommitdiff
path: root/tests/roots
Commit message (Collapse)AuthorAgeFilesLines
* Allow ``copyright`` to contain multiple entries (#10983)Stefanie Molin2023-05-112-0/+11
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Allow multi-line object description signatures (#11011)TLouf2023-05-118-0/+24
| | | | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com> Co-authored-by: TLouf <loufthomas@gmail.com>
* Warn on deprecated Python-specific index types (#11412)Adam Turner2023-05-093-9/+1
|
* linkcheck: Use context managers for HTTP requests (#11318)James Addison2023-05-0910-9/+10
| | | | | | | | This closes HTTP responses when no content reads are required, as when requests are made in streaming mode, ``requests`` doesn't know whether the caller may intend to later read content from a streamed HTTP response object and holds the socket open. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Remove the deprecated Setuptools integration (#11363)Adam Turner2023-04-273-3/+0
|
* Revert "Support and prefer ``.jinja`` to ``_t`` for static templates ↵James Addison2023-04-235-2/+0
| | | | | (#11165)" (#11329) This reverts commit 5d13215b58f93c6be8255ef2e3e20836508c7d47.
* Increase timeout threshold for ``linkcheck`` tests (#11326)James Addison2023-04-219-9/+9
|
* Fix duplicated labels in TeX output (#11093)Bénédikt Tran2023-04-176-0/+64
|
* Use leaner TeX syntax (follow-up to #11319)Jean-François B2023-04-119-18/+18
| | | | Because it is cool. And avoids overhead. Matter of principle.
* LaTeX: get aligned longtable obey current list indentJean-François B2023-04-119-9/+45
| | | | | | Fix #11268. Thanks to @picnixz.
* Support and prefer ``.jinja`` to ``_t`` for static templates (#11165)James Addison2023-04-075-0/+2
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Disable localisation when ``SOURCE_DATE_EPOCH`` is set (#10949)James Addison2023-04-072-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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/
* autosummary: Support documenting inherited attributes (#10691)Jens Hedegaard Nielsen2023-04-062-0/+15
| | | | | | | | | | | 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 <9087854+AA-Turner@users.noreply.github.com>
* Support type comments in ``PropertyDocumenter`` (#11298)picnixz2023-04-062-0/+16
|
* Autosummary: Extend ``__all__`` members to template rendering (#10811)Clément Pinard2023-04-066-2/+71
| | | | | | | | | | | | | 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``
* Remove hidden state from ``test_nosearch`` (#11291)Martin Liška2023-04-053-2/+3
| | | | | | Currently, ``test_nosearch`` depends on ``html_search_language='de'`` from a previous test and thus fails if run individually. Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Add unit test for issue #11110 as fixed by #11113Jean-François B2023-04-035-0/+57
|
* Let the #11276 test actually be one which would have failed earlierJean-François B2023-03-311-0/+10
|
* Fix #11274: external links may break PDF build if under \sphinxupquoteJean-François B2023-03-311-0/+6
|
* Fix typos found by codespellDimitri Papadopoulos2023-03-271-2/+2
|
* Increase ``test_linkcheck`` timeoutsAdam Turner2023-03-249-13/+9
|
* Speed up ``test_linkcheck``Adam Turner2023-03-2415-23/+37
|
* Remove tests that rely on setuptoolsAdam Turner2023-03-056-37/+0
|
* Remove ``.egg`` support from pycode ``ModuleAnalyser``Adam Turner2023-03-055-17/+0
| | | | Python eggs are a now-obsolete binary distribution format.
* LaTeX: fix 5.1.0 bugs related to topic and contents boxes (#11102)Jean-François B2023-01-061-0/+72
| | | | | | | | | | | | | | | | | | * Fix #11095 (PDF wrong placement of shadow of topic boxes since 5.1.0) * Fix #11096 (LaTeX shadowsize regression at 5.1.0) * Fix #11099 (shadowrule legacy sphinxsetup key vanished at 5.1.0) * Fix #11101 (LaTeX div.topic_padding of sphinxsetup had wrong name) * Add some checks that various sphinxsetup keys do not break PDF build * Update LaTeX docs * Update CHANGES * Can not use :dudir:`contents` has it links to wrong place
* Run pyupgrade (#11070)Adam Turner2023-01-027-14/+14
|
* Insert ``from __future__ import annotations``Adam Turner2023-01-0114-1/+33
|
* Happy New Year!Adam Turner2023-01-011-1/+1
|
* Make copyright text inclusion test date-independentAdam Turner2023-01-011-1/+1
| | | | Improve clarity on what the test is looking for in the footer
* Factor out HTML 4 translator (#11051)Adam Turner2022-12-303-11/+11
| | | Move the HTML 4 translator into a private module.
* Add test coverage for 'today_fmt' reference substitution (#10980)James Addison2022-12-291-0/+1
|
* Run the ``pyupgrade`` toolAdam Turner2022-10-1720-38/+32
|
* Prefer ``raise SystemExit`` to ``sys.exit``Adam Turner2022-10-172-6/+2
|
* Merge branch '5.x'Adam Turner2022-10-1633-198/+432
|\ | | | | | | | | | | | | | | # Conflicts: # .github/workflows/main.yml # CHANGES # sphinx/__init__.py # sphinx/domains/c.py
| * Allow sections in object description directives (#10919)Adam Turner2022-10-152-0/+6
| |
| * URI-escape image filenames (#10268)Eric Wieser2022-10-133-0/+5
| | | | | | | | | | | | | | | | Without this change, local images with `#` in their name result in incorrect URLs There is already a similar call to `urllib.parse.quote` for file downloads, suggesting this is a sensible approach. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
| * LaTeX: support for booktabs-style and zebra-striped tables (#10759)Jean-François B2022-10-1226-197/+417
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a combination of 2 + 28 + 7 + and some more commits... * Cherry-pick: Add support for booktabs-style tables to LaTeX builder * Cherry-pick: Add support for zebra-striped tables to LaTeX builder Co-authored-by: Stefan Wiehler <stefan.wiehler@missinglinkelectronics.com> Above work originally initiated by @sephalon (thanks!) Development refactored and continued by @jfbu * latex_table_style configuration, support booktabs, colorrows, borderless Some details: - Simplify a bit a conditional in the longtable template This also puts the target for a longtable with a label but no caption above the toprule for better hyperlinking (testing shows hyperlink target can not end up alone at bottom of previous page). - Extend allowed syntax for colour assignments via 'sphinxsetup' - latex_table_style new configuration value and coloured rows For the user interface I tried to look for inspiration in https://docutils.sourceforge.io/docs/user/config.html#table-style which mentions booktabs and borderless. They also mention captionbelow which we can implement later, now that architecture is here. They don't mention coloured rows. - Test on our own document... looks fine! - Work-around an incompatibility of \cline with row colours - Reverse priority of classes to allow overruling booktabs by standard after parsing source but before letting LaTeX writer act - Closes #8220 Commit https://github.com/sphinx-doc/sphinx/commit/bb859c669679baebd8cc8d10c99382478c0d1647 already improved a bit, this finishes it (as :rst:dir:`rst-class` was actually not linking to anywhere). - Let booktabs style defaults to *not* using \cmidrule. They actually don't make much sense there, as all \hline's are removed. - Add \sphinxnorowcolor which allows construct such as this one in a tabularcolumns directive: >{\columncolor{blue}\sphinxnorowcolor} else LaTeX always overrides column colour by row colour - Add TableMergeColorHeader, TableMergeColorOdd, TableMergeColorEven so single-row merged cells can be styled especially - Extend row colours to all header rows not only the first one (all header rows will share same colour settings) - Auto-adjust to a no '|'-colspec for optimal handling of merged cell - Add \sphinxcolorblend - Workaround LaTeX's \cline features and other grid tables matters - Add \sphinxbuildwarning for important warnings - Fix some white gaps in merged cells of tables with vlines and colorrows - Work around LaTeX's \cline serious deficiencies for complex grid tables This commit corrects \cline badly impacting vertical spacing and making tables look even more cramped as they usually are in LaTeX (although one sees it clearly only with \arrarrulewidth a bit more than the LaTeX default of 0.4pt). Most importantly this commit solves the problem that \cline's got masked by colour panels from the row below. - Update CHANGES for PR #10759 - Improve documentation of new latex_table_style regarding colours
| * Don't display 'replaceable hardcoded link' when link has a slash (#10137)Anthony Sottile2022-10-051-0/+2
| |
| * Extend cross referencing options with values (#10883)Martin Liška2022-10-021-1/+2
| | | | | | | | | | | | | | | | This change means that text following `=`, `[=`, or ` ` is ignored when searching for a corresponding option directive to an option cross reference role. These are commonly used options, for example `--profile=path`, `--profile[=path]` or `--profile path`. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* | Merge branch '5.x'Adam Turner2022-09-301-0/+13
|\ \ | |/ | | | | | | # Conflicts: # sphinx/locale/__init__.py
| * extend option directive syntaxMartin Liska2022-09-271-0/+13
| | | | | | | | One can cross-reference an option value: :option:`--module=foobar`.
* | Drop Python 3.7Adam Turner2022-09-272-12/+0
|/
* Clear `record_dependencies` for each document (#10855)Adam Turner2022-09-244-0/+14
|
* Add contents entries for domain objects (#10807)Adam Turner2022-09-133-0/+45
| | | | | | | | | - Add entries in the table of contents for domain objects (e.g. `py:function`, `rst:role`, etc). Supported domains are Javascript, Python, and reStructuredText. - Support content in `py:module` and `js:module` directives. - Add the `noindexentry` and `noindex` flags to more domains. - Add `toc_object_entries_show_parents` configuration setting - Update documentation and tests
* Make toctree accept special docnames (#10673)Brecht Machiels2022-09-123-0/+23
| | | | | | The `.. toctree::` directive now supports the reserved special docnames 'genindex', 'modindex', and 'search'. Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* Remove unneeded `noqa` lint suppression comments (#10772)danieleades2022-08-2813-22/+22
|
* linkcheck: Check the source URL of raw directivesn-peugnet2022-08-171-0/+3
| | | | | | Add raw directives' source URL to the list of links to check with linkcheck. By the way, refactor HyperlinkCollector by adding `add_uri` function. Add test for linkcheck raw directives source URL
* Allow specifying multiple CSS files in themes (#10465)Takeshi KOMIYA2022-07-175-0/+7
| | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* py domain: Ignore aliases for resolving `:any:` cross-references (#10089)Joachim Jablon2022-06-261-0/+3
| | | | Co-authored-by: Joachim Jablon <joachim.jablon@people-doc.com>
* Allow emphasising placeholders in `option` directives (#10366)Martin Liška2022-06-161-0/+9
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
View Lorry Controller Status