Adam Turner
4a3febb69a
Add an option for displaying short `Literal` types ( #11109 )
...
The new ``python_display_short_literal_types`` configuration option
for the ``py`` domain controls display of PEP 586 ``Literal`` types.
The 'short' format is inspired by PEP 604, using the bitwise OR operator
to distinguish the possible legal values for the argument.
2023-04-05 13:07:25 +01:00
Jean-François B
e1b15a5c11
Update doc and CHANGES for PR #11281
2023-04-03 11:12:41 +02:00
Jean-François B
8f9bac9c4f
LaTeX: rename `\sphinxnotetitle into \sphinxstylenotetitle` (etc)
...
Follow-up to #11266 . Using \sphinxstyle prefix looked a posteriori
better, for coherency, although it is a bit long.
2023-03-27 15:21:06 +02:00
Jean-François B
7cdd9b2679
LaTeX: let \sphinxremovefinalcolon work also if no colon in input
2023-03-27 12:21:26 +02:00
Dimitri Papadopoulos
669bcc0a19
Fix typos found by codespell
2023-03-27 07:22:07 +02:00
Jean-François B
7144f4924a
LaTeX: add \sphinxnotetitle et al.
...
In passing I reverted some deprecation I had added at 6bf40599e
2023-03-26 23:57:04 +02:00
Jean-François B
a7949d4290
LaTeX: let mark-up for seealso directive use explicit colon ( fix #11264 )
2023-03-26 23:57:04 +02:00
Hugo van Kemenade
318914fff2
Fix syntax in `:manpage:` role example ( #11249 )
2023-03-24 01:36:58 +00:00
Adam Turner
f5c957597d
Normalise spelling of Sphinx versions
2023-03-24 00:44:33 +00:00
Dmitry Shachnev
54f531e978
Remove obsolete workarounds in `doc/conf.py` ( #11250 )
...
Loading jQuery is not needed since January 2023:
https://github.com/readthedocs/readthedocs.org/pull/9861
And exposing app.{info,warn,debug} is not needed since September 2018:
https://github.com/readthedocs/readthedocs-sphinx-ext/pull/51
2023-03-23 21:42:28 +00:00
Benjamin Balder Bach
eda388a506
Docs: Add a link to sphinx-extensions ( #11260 )
2023-03-23 08:33:16 +01:00
Jean-François B
ec25892dd9
LaTeX: doc updates
...
modified: doc/latex.rst
2023-03-20 10:34:15 +01:00
Jean-François B
8ed2c6708d
LaTeX: update doc, trim unneeded extra examples
2023-03-20 00:10:31 +01:00
Jean-François B
de60cd8618
LaTeX: support elliptical corners in rounded boxes
2023-03-19 21:47:03 +01:00
Jean-François B
f78d86554c
LaTeX: remove more-or-less obsolete doc
2023-03-19 21:23:06 +01:00
Jean-François B
cf6273a6b1
LaTeX: fix nits with some mark-up in doc and code comment
2023-03-19 19:09:08 +01:00
Jean-François B
b433d4cb9d
LaTeX: warn about \sphinxbox addstrut default possibly changed at 7.0.0
2023-03-19 18:33:13 +01:00
Jean-François B
6bf40599e2
LaTeX: add <prefix>_{TeXcolor,TeXextras} options
...
And add <type>TextColor and <type>TeXextras for <type>=hint, important,
note, tip for variants which do not trigger for sphinxheavybox but
still uses sphinxlightbox (suitably enhanced).
Similar named TeXcolor and TeXextras options for \sphinxbox.
2023-03-19 18:29:09 +01:00
Jean-François B
4d7347cf1b
LaTeX: reset options in nested \sphinxbox'es
2023-03-19 18:28:37 +01:00
Adam Turner
2902c6c55b
Deprecate legacy `intersphinx_mapping` format ( #11247 )
...
This format was made obsolete in Sphinx 1.0, but never formally deprecated.
2023-03-17 16:41:22 +00:00
Hugo van Kemenade
ba4c67b1dc
Display examples of roles in the documentation ( #11226 )
...
Show examples of roles in the docs so we can see how they look.
Seeing how roles are displayed helps us decide whether to use them.
2023-03-17 15:05:09 +00:00
Jean-François B
e80c1e6b31
LaTeX: let rounded boxes support up to 4 distinct border-widths
...
Internally replace "strokepath" operation for drawing the border
(which mandated constant border-width) by only "fillpath" operations.
This also allowed to significantly simplify some other aspects of the
code related to box-decoration-break=slice.
2023-03-15 17:59:43 +01:00
Jean-François B
78e14fb6ba
LaTeX: add boolean option addstrut to \sphinxbox/\sphinxboxsetup
2023-03-14 23:52:32 +01:00
Jean-François B
ee3c720cfa
LaTeX: also admonition directives support box-decoration-break=slice
2023-03-13 19:50:31 +01:00
Jean-François B
99863fb080
LaTeX: encapsulate dimension options in \dimexpr
2023-03-13 12:25:47 +01:00
Jean-François B
85fbfe1fa9
LaTeX: polish code comments
2023-03-13 10:47:01 +01:00
Jean-François B
819c7d508d
LaTeX: mumble with trailing whitespaces in latex.rst
2023-03-12 18:37:21 +01:00
Jean-François B
e1c521f38b
LaTeX: documentation and a mark-up fix in latex.rst
2023-03-12 18:28:54 +01:00
Jean-François B
aeeadb6f1e
Fix #11235 : LaTeX: `\color` may cause color leaks in topic or notices
2023-03-12 15:55:57 +01:00
Jean-François B
212ed5b940
LaTeX: add support for styling `note (hint, ...) similarly as warning ( danger`, ...) ( #11234 )
2023-03-12 11:28:36 +01:00
Jean-François B
d50ae3c1c9
LaTeX: fix some documentation from #11224
2023-03-07 19:10:43 +01:00
Jean-François B
e39949fed0
Update some LaTeX comments and documentation after #11224
2023-03-07 13:58:02 +01:00
Jean-François B
b635150bc7
LaTeX: `\sphinxbox` for boxing inline text elements
2023-03-07 13:19:19 +01:00
Adam Turner
f435fc05e6
Prefer `contextlib.chdir to sphinx.util.osutil.cd`
2023-03-05 18:49:17 +00:00
Hugo van Kemenade
219d71315c
Make `--jobs a synonym for -j` ( #11210 )
...
Make --jobs a synonym for -j
2023-03-05 14:37:35 +00:00
Adam Turner
c8f4a03dac
Fix COM812
2023-02-18 01:58:05 +00:00
Mike Taves
23bf041ce4
Remove unicode prefix (`u`) from strings ( #11158 )
2023-02-15 04:37:33 +00:00
Adam Turner
c17300aa7a
Treat Python warnings as errors during testing
2023-02-15 04:34:10 +00:00
Adam Turner
ff852bc7c3
Update GitHub Actions workflows
2023-02-15 03:10:50 +00:00
Hugo van Kemenade
7f62f539be
Correct the Python Developer Guide markup style advice link ( #11189 )
2023-02-11 13:19:51 +00:00
Jean-François B
b88713e68e
Update LaTeX docs
2023-01-24 14:45:46 +01:00
Jean-François B
55170d01d7
LaTeX: `\emph replaced by \sphinxparam and \sphinxsamedocref`
2023-01-24 14:11:24 +01:00
Jean-François B
ddf4daf2c6
Doc of html_file_suffix ( closes #11141 ) ( #11144 )
2023-01-22 19:32:12 +01:00
Adam Turner
670bcb743b
Documentation reshuffle ( #11112 )
2023-01-08 13:52:36 +00:00
Jean-François B
6259c2b723
Markup typo in docs
2023-01-07 00:03:52 +01:00
Jean-François B
7945aeb22d
LaTeX: fix 5.1.0 bugs related to topic and contents boxes ( #11102 )
...
* 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
2023-01-06 23:52:19 +01:00
Adam Turner
a2176d47b5
Fix deprecation warnings
2023-01-05 12:17:54 +00:00
jgart
0fbd8afc05
Add missing default arguments in sphinx-apidoc.rst ( #11084 )
...
Add the missing default arguments to two CLI flags, ``-l`` and ``-d``
2023-01-05 11:44:02 +00:00
Adam Turner
5eb79c126a
Move exception formatting utilities to `sphinx.util.exceptions`
2023-01-03 22:09:30 +00:00
Adam Turner
3b3ce9cf7b
Move HTTP-date formatting utils to utils.http_date
2023-01-03 19:02:38 +00:00
Adam Turner
Jean-François B
Dimitri Papadopoulos
Hugo van Kemenade
Dmitry Shachnev
Benjamin Balder Bach
Mike Taves
jgart