Commit Graph

19755 Commits

Author SHA1 Message Date
Martin Liška
bf4a626826
RTD builder: add graphviz depedendency (#11040) 2022-12-20 12:30:59 +00:00
Hugo van Kemenade
644043c317 Remove redundant instructions from PR template 2022-12-16 16:56:43 +01:00
Daniel Eades
841c0cecb3 check for blanket noqas in CI 2022-12-16 16:50:24 +01:00
Daniel Eades
1abb24e309 remove blanket 'noqas' 2022-12-16 16:50:24 +01:00
Hugo van Kemenade
dc29bf9abe
Docs: Update devguide link (#11017)
Update devguide link
2022-12-16 16:42:11 +01:00
amyreyespdx
782c663c0c
doc: Fix typos in contributing.rst (#10961) 2022-12-16 16:38:53 +01:00
Jean-François B
7418d2ccc4
Deactivate (provisorily) Python12-dev testing (#11035)
* fix flake8 warnings

* Deactivate (provisorily) testing with 3.12-dev

(refs:
https://github.com/sphinx-doc/sphinx/pull/10995#issuecomment-1330310586
)

* Escape # in tox.ini for tox 4 compatibility ('du-latest' tests)

Co-authored-by: Daniel Eades <danieleades@hotmail.com>
2022-12-16 12:41:54 +01:00
Jérémie Tarot
d8977d3e57
docs: intl.rst: small fixes while translating (#11020) 2022-12-07 13:53:44 +01:00
Jean-François B
b1ca6b3e12
Fix #10984 [DOC] document latex_additional_files behavior with .tex (#10993) 2022-11-30 18:52:48 +01:00
Adam Turner
cd3f2e4350 Update typing ignores for mypy 0.990 2022-11-13 20:36:24 +00:00
Adam Turner
a6032e852a Recommend `sphinxcontrib.jquery` in CHANGES 2022-11-06 23:48:28 +00:00
Jean-François B
2f60b44999 Avoid a cramped LaTeX table column in our own document
This is for the table of the Websupport.get_data() auto-documentation.

Somethink similar perhaps \setlength{\tymin}{1.5cm} at least could be a
global default; the only reason we have not changed it yet is that
perhaps some tables in user projects use really short contents such as
letter.

(what we would want to avoid is narrow columns allowed by hyphenation of
single words; maybe some thinking needed here as \sphinxAtStartPar
renders this hyphenation possible but perhaps even upstream LaTeX has
now made hyphenation of single words work in table cells).
2022-10-30 17:09:30 +01:00
Adam Turner
4bf9f65680
Use Sphinx 5.3+ in bug report template 2022-10-28 22:12:02 +01:00
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 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 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 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
Eric Wieser
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 B
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
  bb859c6696
  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 Schueller
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ška
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