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,877 Commits 2 Branches 219 Tags 163 MiB
6845c3fd96
Commit Graph

19877 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Adam Turner
5eb79c126a Move exception formatting utilities to `sphinx.util.exceptions` 2023-01-03 22:09:30 +00:00
Adam Turner
081d72b2f7 Deprecate `path_stabilize via deprecated_alias` 2023-01-03 21:40:29 +00:00
Jean-François B
2b2c62aa78 Fix #11074: Can't change sphinxnote to use sphinxheavybox 2023-01-03 20:19:32 +01: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
Adam Turner
1b887e4c5c Update ruff configuration 2023-01-03 18:37:20 +00:00
Jean-François B
27cf496eaf Trim duplicate in sphinxlatexadmonitions.sty latex code 2023-01-03 19:34:52 +01: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
Jean-François B
08ca934fff Add 6.1.0 section to CHANGES 2023-01-03 17:29:14 +01:00
Adam Turner
29e12ec4db
Document `typing.NewType` as a class (#10700) 2023-01-02 18:57:04 +00:00
Tim Hoffmann
ec26c2f874
Document autosummary template variable "objtype" (#11044) 2023-01-02 18:38:17 +00:00
danieleades
94e6e3917f
De-glob mypy whitelist for 'sphinx.domains.*' (#11064) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-01-02 18:32:44 +00:00
danieleades
256e521807
Shrink mypy whitelist for 'util.nodes' module (#11061) 2023-01-02 17:55:53 +00:00
Adam Turner
77a02cf696
Use PEP 604 display for `typing.Optional and typing.Union` (#11072) 2023-01-02 17:49:18 +00:00
Adam Turner
dc3f22a370 Make MyPy happy 2023-01-02 17:41:28 +00:00
Adam Turner
b32841e153 Move tasks into parallel writing 2023-01-02 17:41:13 +00:00
Adam Turner
087522cf79 Rewrite IndexBuilder loading 2023-01-02 17:40:38 +00:00
Adam Turner
4c44f22009 Use `re` flags 2023-01-02 17:39:35 +00:00
Adam Turner
bc262cc8f1 Cosmetic refactor of `_entries_from_toctree` 2023-01-02 17:39:17 +00:00
Adam Turner
085a293357 Don't re-read doctrees from disk unnecessarily 
Cache the loaded doctree and deepcopy on return
 2023-01-02 17:38:19 +00:00
hofmandl1
b26b9ba971
Add faster `TocTree._toctree_copy` method (#10988) 
As in the standalone html builder the navigation is flattened out for
every single html page, the code needs to create a specialised
toctree for every html page. Previously this was done by deep-copying
the complete navigation toctree and then stripping out the parts not
needed on the particular page. With this change the code only
(deep)-copies the needed parts of the toctree avoiding unnecessary
copying and throwing-away. The performance improvements seems to be
smaller for smaller page counts and get bigger the more pages are
involved.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-01-02 10:46:56 +00:00
Philip Meier
6037ec3b9b
Use `finally` to terminate parallel processes (#10952) 2023-01-02 09:22:45 +00:00
danieleades
cc8f697a9b
Address SIM103 lints (#11052) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-01-02 09:21:32 +00:00
danieleades
dbf36f8b37
Shrink 'any-generics' whitelist for 'writers' module (#10867) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2023-01-02 05:29:46 +00:00
danieleades
c2e278520e
Add SIM905 lint (#11055) 
This lints for use of a list of strings instead of splitting a constant string on whitespace
 2023-01-02 05:02:42 +00:00
danieleades
2759c2c76b
Use `any` to find elements in iterable (#11053) 2023-01-02 04:52:46 +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
Rotzbua
ede68fa423
Remove obsolete HTML keyword `link rel="shortcut"` (#11069) 
The link relationship keyword `shortcut` does not appear in the HTML 5 specification [1].

It was used by historic browsers (i.e. Internet Explorer 6) which Sphinx no longer supports.

[1]: HTML5 Specification, 4.6.7.8 Link type "icon", https://html.spec.whatwg.org/#rel-icon
 2023-01-01 22:18:13 +00:00
Frazer McLean
5841080319
Clarify licence in Sphinx's metadata (#10956) 
Disambiguate which BSD license is used in a computer-parsable form.
 2023-01-01 22:12:55 +00:00
Adam Turner
14a9289d78 Use PEP 604 types 2023-01-01 20:48:39 +00:00
Adam Turner
26f79b0d2d Use PEP 595 types 2023-01-01 20:48:38 +00:00
Adam Turner
f4c8a0a68e Insert `from __future__ import annotations` 2023-01-01 20:48:37 +00:00
Adam Turner
0b1efd7756 Add Pygments version to sphinx --bug-report 2023-01-01 19:45:40 +00:00
Adam Turner
f8e8584ea5 Update GitHub bug report template 2023-01-01 19:44:35 +00:00
Adam Turner
a1c10f5d5e Happy New Year! 2023-01-01 19:40:01 +00:00
Adam Turner
a6257fc83b Make copyright text inclusion test date-independent 
Improve clarity on what the test is looking for in the footer
 2023-01-01 19:38:55 +00:00
Adam Turner
1e900a26e8 Merge branch '6.0.x' 2023-01-01 19:17:24 +00:00
Adam Turner
965768bfda Fix tests for Pygments 2.14 
Pygments 2.14 was released on 01/01/2023 [0]

[0]: https://pygments.org/docs/changelog/#version-2-14-0
 2023-01-01 19:17:03 +00:00
danieleades
bd71d6e85a
Add the `SIM300` lint (#11058) 
``SIM300`` is 'yoda conditions' [0]. These have already been fixed in
this repo, but we might as well add the lint to prevent them being
inadvertently re-added.

[0]: https://github.com/MartinThoma/flake8-simplify#SIM300
 2023-01-01 17:59:23 +00:00
danieleades
124bbce049
Fix `SIM904`, directly construct dicts (#11059) 2023-01-01 17:54:11 +00:00
Adam Turner
ff202240ab Merge branch '6.0.x' 2022-12-31 17:38:32 +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
Adam Turner
03c6244949 Re-enable CI testing with Python 3.12 alphas 
This partially reverts commit 7418d2ccc4
 2022-12-30 18:11:52 +00:00
Adam Turner
aeda313430 Reflect changes to `Enum` signature in Python 3.12 2022-12-30 18:11:52 +00:00
John Gardner
28d184c0d6
Add test for multi-word key names (`kbd` role) (#10765) 2022-12-30 00:57:51 +00:00
Adam Turner
bf06d7ef4d
Factor out HTML 4 translator (#11051) 
Move the HTML 4 translator into a private module.
 2022-12-30 00:53:04 +00:00
textshell
aa2fa38fef
Fix lookup table for multi-word key names (`kbd` role) (#10962) 
It seems the original PR adding multi word key support forgot to add
commas and python helpfully just concatenated the strings instead of
building the required tuples.
 2022-12-30 00:52:29 +00:00
Adam Turner
b91f6617ed Enable Ruff's pylint 'PLC2201' check 
Address all cases where the comparison order check is violated
 2022-12-30 00:06:11 +00:00
Adam Turner
2c97bfaa19 Remove redundant import aliases with isort 2022-12-29 23:53:48 +00:00