IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
19,981 Commits 2 Branches 219 Tags
4d7347cf1bc0231c1bedea27c601c7122014888f
Commit Graph

3661 Commits

Author SHA1 Message Date
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
8c5e7013ea Move console output utilities to `sphinx.util.display` 
- Merge `old_status_iterator` into ``status_iterator``.
  ``old_status_iterator`` was deprecated in version 1.6.
 2023-01-03 18:37:20 +00:00
Jean-François B
bfd95dadf2 Fix #6744: support for seealso directive should be via an environment 2023-01-03 18:58:39 +01:00
Tim Hoffmann
ec26c2f874 Document autosummary template variable "objtype" (#11044) 2023-01-02 18:38:17 +00:00
Adam Turner
77a02cf696 Use PEP 604 display for `typing.Optional and typing.Union` (#11072) 2023-01-02 17:49:18 +00:00
Harrissou Sant-anna
da6a20d50b Fix typos in usage/configuration.rst (#10834) 2023-01-02 04:48:53 +00:00
Adam Turner
4032070e81 Run pyupgrade (#11070) 2023-01-02 00:01:14 +00:00
Adam Turner
14a9289d78 Use PEP 604 types 2023-01-01 20:48:39 +00:00
Adam Turner
f4c8a0a68e Insert `from __future__ import annotations` 2023-01-01 20:48:37 +00:00
Viktor Haag
5715abf1d4 Update removal note for logo and favicon variables (#11063) 
These were removed in Sphinx 6.0.0
 2022-12-31 17:38:06 +00:00
mikemckiernan
32bce8fb7c Copy edit the tutorial (#11049) 
- Correct two typos.
- Include the ingredient index in the "for example"
  statement. It's tedious, but the audience is reading
  to learn.
 2022-12-29 13:58:32 +00:00
Martin Liška
9844162473 Fix example using `add_config_value` (#10937) 
``add_config_value()`` has mandatory 3 arguments.
 2022-12-20 13:15:00 +00: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
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
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
Dmitry Shachnev
93215f0a64 doc: Actualize information about generating snowball JS files (#10931) 2022-10-24 01:07:05 +01:00