Commit Graph
19742 Commits
Author SHA1 Message Date
Adam Turner 33d65fbdaf Merge Docutils master tests into the main workflow 2022-10-27 09:53:56 +01:00
Adam Turner 69035f5315 Automatically cancel CI runs when new commits are pushed 2022-10-27 09:50:52 +01:00
Adam Turner 995e2615a7 Test on Python 3.12 prereleases 2022-10-27 09:48:14 +01:00
Dmitry Shachnev 93215f0a64 doc: Actualize information about generating snowball JS files (#10931) 2022-10-24 01:07:05 +01:00
Xuan Wang b90bf8d193 Bump required requests version to 2.25.0 (#10929) 2022-10-22 01:33:32 +01:00
Adam Turner cc314f13e8 Bump version 2022-10-17 22:40:57 +01:00
Adam Turner 4c2a82305c Bump to 6.0.0 beta2 v6.0.0b2 2022-10-17 22:40:11 +01:00
Adam Turner 920828fe35 Run the `pyupgrade` tool 2022-10-17 22:39:09 +01:00
Adam Turner b277abcb49 Use `ast.parse` from the standard library 2022-10-17 15:22:06 +01:00
Adam Turner eb6e137097 Merge `_py37 functions in util.typing`
- restify and _restify_py37
- stringify and _stringify_py37
2022-10-17 15:22:06 +01:00
Adam Turner dd7f65c98f Prefer `raise SystemExit to sys.exit` 2022-10-17 15:22:06 +01:00
Martin Liška 2a70006e59 Link to static JS libraries from Sphinx 5.3 (#10926)
This is the last Sphinx minor version to include ``jquery.js`` and ``underscore.js``.
2022-10-17 13:17:30 +01:00
Jean-François B 49c48f5aee LaTeX: switch to some nicer defaults for tables and code-blocks (#10924) 2022-10-17 11:19:25 +02:00
Jean-François B 78cf903bc1 Update documentation of latex builder (#10925) 2022-10-17 10:54:31 +02:00
Adam Turner ae42de48eb Bump version 2022-10-16 16:57:26 +01:00
Adam Turner 25851e115a Bump to 6.0.0 beta1 v6.0.0b1 2022-10-16 16:55:06 +01:00
Adam Turner 0200a75fe1 Simplify development policy (#10921) 2022-10-16 16:51:22 +01:00
Adam Turner 592b46c431 Revert `html_codeblock_linenos_style` removal (#10922) 2022-10-16 16:50:53 +01:00
Adam Turner e70a0fac6d Merge branch '5.x'
# Conflicts:
#	.github/workflows/main.yml
#	CHANGES
#	sphinx/__init__.py
#	sphinx/domains/c.py
2022-10-16 11:24:18 +01:00
Adam Turner c1f2a52d5d Bump to 5.3.0 final v5.3.0 2022-10-16 10:56:11 +01:00
Adam Turner 10db540e98 Allow sections in object description directives (#10919) 2022-10-15 23:01:25 +01:00
Adam Turner 0fd45397c1 Simplify bug report template 2022-10-14 16:05:54 +01:00
Adam Turner b58eb61c9f Update all GitHub actions workflows to Ubuntu latest 2022-10-14 16:04:04 +01:00
Adam Turner 3e04952a87 Add `sphinx-build --bug-report` 2022-10-14 16:03:59 +01:00
fa6d42597f URI-escape image filenames (#10268)
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>
2022-10-13 17:37:07 +01:00
Martin Liška e008e16200 Revert "Fix detection for out of date files (#9360)" (#10908)
This reverts commit b1390c4191.

The change is reverted because some builders don't have
fine-grained support for outdated docs:
https://github.com/sphinx-doc/sphinx/issues/10903#issuecomment-1273199352
2022-10-13 13:16:17 +01:00
Adam Turner cef1a030cd Update image for LaTeX job (#10916) 2022-10-12 23:01:55 +01:00
Jean-François B b5ba1ede2a s/5.2.0/5.3.0 in various code comments as #10759 got merged in 5.3.0 2022-10-12 17:41:39 +02:00
Jean-François B 3deb5275be Update CHANGES for PR #10759 2022-10-12 17:27:20 +02:00
Jean-François BandStefan Wiehler e7c0881992 LaTeX: support for booktabs-style and zebra-striped tables (#10759)
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
2022-10-12 17:15:40 +02:00
Adam Turner 82cb4cdb2b Remove support for parsing pre-v3 syntax in the C domain (#10901) 2022-10-09 15:55:46 +01:00
Julien SchuellerandAdam Turner c51a88da8b Fix performance regression for `imgmath` embedding (#10888)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2022-10-09 15:55:02 +01:00
Adam Turner d43e6b3ef4 Note removal of deprecated APIs 2022-10-05 18:38:32 +01:00
Adam Turner 7f5117cb14 Note removal of JavaScript frameworks 2022-10-05 18:30:11 +01:00
Anthony Sottile 6ed4bbba39 Don't display 'replaceable hardcoded link' when link has a slash (#10137) 2022-10-05 14:47:16 +01:00
Martin LiškaandAdam Turner b1390c4191 Fix detection for out of date files (#9360)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-10-05 14:44:41 +01:00
Martin Liška 3d25662550 Update CHANGES for :option: reference format changes (#10892) 2022-10-05 13:40:56 +01:00
Adam Turner 26fe10f0b7 Fix disabling cross-references in pre-v3 C domain (#10890) 2022-10-05 13:37:47 +01:00
Julien Schueller ad5e17beb3 Fix cleanup_tempdir in imgmath (#10895) 2022-10-05 13:36:24 +01:00
Martin PatzandMartin Patz 3e29abf8de Add debug logging to autosectionlabel (#10881)
Co-authored-by: Martin Patz <martin@recogni.com>
2022-10-04 15:25:06 +01:00
Martin LiškaandAdam Turner 0a91adb64d Extend cross referencing options with values (#10883)
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>
2022-10-02 15:50:53 +01:00
Adam Turner 7765940f14 Ensure non-builtin extensions use the proper version 2022-09-30 19:10:48 +01:00
Adam Turner 63dea6172a Merge branch '5.x'
# Conflicts:
#	sphinx/locale/__init__.py
2022-09-30 16:15:24 +01:00
Adam Turner 2906071198 Merge branch '5.2.x' into 5.x
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
2022-09-30 16:13:11 +01:00
Adam Turner cbb19d6947 Bump to 5.2.3 final v5.2.3 2022-09-30 16:08:16 +01:00
Adam Turner 650f63b9f7 Finer grained control over domain ToC entries (#10886)
- Implement `:nocontentsentry:` flag
- Use `:nocontentsentry:` in docs
- Add domain object table of contents configuration option
2022-09-30 10:31:58 +01:00
Julien SchuellerandAdam Turner 7514e5c6d4 CI: Move LaTeX job to GitHub Actions (#10884)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-09-30 00:03:51 +01:00
danieleades bf36a7905a shrink 'any-generics' whitelist for the 'deprecation' module (#10849) 2022-09-29 23:47:58 +01:00
danieleades 6e113d4e90 Use a module level constant as best practice (#10876) 2022-09-29 19:07:29 +01:00
danieleades 3c73efadab shrink 'Any generics' mypy whitelist for builders module (#10846) 2022-09-29 17:26:53 +01:00