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
20,990 Commits 2 Branches 219 Tags 163 MiB
51a964cc8c
Commit Graph

20990 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Adam Turner
a4de250b5a
Add a new `confval` directive to document settings and configuration values (#12536) 2024-07-10 20:44:16 +01:00
Adam Turner
05d1d8aeb2
Fix the type hint for `_load_additional_themes()` (#12535) 2024-07-10 18:41:31 +00:00
Adam Turner
1cc9699b2d
Use `str.format_map` (#12534) 2024-07-10 18:39:22 +00:00
Adam Turner
fa8c81a634
Remove `customsidebar` (#12533) 2024-07-10 19:38:38 +01:00
tuncbkose
bdd9140842
Remove custom SVG processing in the HTML builder (#12425) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-10 18:31:01 +00:00
Adam Turner
bf2e2301e9
Prefer 'nitpicky' to 'nit-picky' (#12532) 2024-07-10 18:24:03 +00:00
James Addison
84c11b2f66
Improve JavaScript test fixture generation (#12531) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-07-10 19:00:34 +01:00
M Bussonnier
6e3a191185
Bump Ruff to 0.5.1 (#12530) 2024-07-10 14:13:10 +01:00
Tim Hoffmann
a95d716f7f
Add a class option to the toctree directive (#12524) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-07-10 11:07:49 +01:00
James Addison
c67ef51df9
Update MyPy for types-docutils 0.21.0.20240708 (#12522) 2024-07-09 20:59:49 +01:00
James Addison
7eb77f2372
HTML Search: omit anchor reference from document titles in the search index. (#12047) 2024-07-08 13:34:11 +02:00
danieleades
082f13f378
Pin the version of 'docutils-types' (#12515) 2024-07-07 17:27:59 +01:00
Stephen Finucane
5ea16e748b
Add tox `lint` target (#11602) 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2024-07-06 19:42:20 +01:00
Adam Turner
59e95531b9
Use a protocol for `RoleFunction` (#12513) 2024-07-06 19:41:53 +01:00
James Addison
e63e2f3ccb
Update MyPy for types-docutils 0.21.0.20240704 (#12511) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-06 19:29:18 +01:00
Nicolas Peugnet
b23ac4f16e
Fix invalid genindex.html file produced with translated docs (#12495) 2024-07-04 03:00:28 +02:00
Tim Hoffmann
57bf4dd9f7
Fix the reference to Python as a user of Sphinx (#12509) 2024-07-04 01:31:33 +01:00
Chris Sewell
8387f4a491
[html] propagate rel attribute from reference nodes (#12489) 
See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel,
this allows third-party extensions to set this attribute on the node and have it propagate to the output HTML
 2024-07-03 12:53:16 +02:00
Adam Turner
086a7913d8 Sort CHANGES into chronological order 2024-07-03 03:30:24 +01:00
Bénédikt Tran
3209275a4a
Support `typing_extensions.Unpack` (#12258) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-03 03:03:41 +01:00
James Addison
778013f91a
Regression: restore extraction of data-URI images from source for builders whose output formats do not support them natively (#12344) 2024-07-03 02:16:43 +01:00
Adam Turner
b5b383fd47
Rewrite the "Docutils markup API" page (#12505) 2024-07-03 02:09:15 +01:00
Adam Turner
24a0385997
Add `allow_section_headings` to SphinxDirective parsing methods (#12503) 2024-07-02 23:53:58 +01:00
Adam Turner
9276639fa6
Remove `inliner_parse_text` (#12504) 
This function is superfluous.
 2024-07-02 23:31:56 +01:00
Inada Naoki
122103f7be
Maintain XHTML compatibility in split genindex (#12386) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-07-02 22:51:55 +01:00
Adam Turner
9fdc241db5 Add PR number for GH-12492 in CHANGES 2024-07-02 22:50:35 +01:00
Adam Turner
86c51f3bfa Bump Ruff to 0.5.0 2024-07-02 22:50:35 +01:00
Adam Turner
21f7006d22
Improve `get_location()` (#12502) 2024-07-02 22:41:48 +01:00
Adam Turner
00cc5f6585 Fix the link to the MathJax CDN guide 2024-07-02 22:32:27 +01:00
Adam Turner
1887df0b5c
Add reStructuredText parsing functions to `SphinxDirective` (#12492) 2024-07-02 22:14:19 +01:00
James Knight
f0c5178176
Use Windows-specific Colorama initialisation (#12493) 
Signed-off-by: James Knight <james.d.knight@live.com>
 2024-07-02 21:17:09 +01:00
Adam Turner
d2f1acc0ca
Simplify `Tags` (#12490) 
- Use a set to store the list of tags
- Cache evaluated expressions
- Extract locally-defined function into a private method
 2024-06-29 10:21:23 +01:00
Ondřej Navrátil
3b3a7d911b
[toctree] Adding warning type/subtype toc.no_title (#12479) 
Add warning type and subtype to warning generated in toctree
 2024-06-27 23:34:46 +02:00
James Addison
751e9162c0
[maintenance] self-linkcheck the Sphinx documentation. (#12487) 
Fixups for a few broken links in the Sphinx documentation, as found using the `linkcheck` builder.
 2024-06-27 23:32:50 +02:00
Chris Sewell
953c0097ef
[docs] add icons to admonition titles (#12486) 
and also replace ad-hoc "more" icon in quickstart, with using `seealso` admonition
 2024-06-27 23:06:52 +02:00
Chris Sewell
d130c2e710
[docs] Improve tutorials (#12473) 
This commit make it clearer, from the filenames and titles,
what the extension tutorials are intended to teach.
 2024-06-27 22:30:03 +02:00
Chris Sewell
0b5fd6289d
[docs] Improve contents title style (#12485) 2024-06-27 21:31:15 +02:00
Chris Sewell
ad6f659eb2
[docs] Add Previous/Next links after content (#12466) 2024-06-27 14:58:50 +02:00
EcaleD
f85f50e526
[DOCS] Fix typo (#12476) 2024-06-25 12:18:34 +02:00
Tim Hoffmann
a53a758d40
DOC: Rewrite installation instructions (#12458) 
- Put pip and conda as the most common options first
- Don't distinguish Linux / Windows in the pip commands.
- Replace the venv instructions by a general tip to use environments and link out for details.
- Collect all OS-specific package manager in one section
- Remove the "Windows - Other methods" secion. 
- Move latest development release to a separate entry. 

Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
 2024-06-25 12:17:55 +02:00
dependabot[bot]
b70578f80c
Bump ruff from 0.4.7 to 0.4.10 (#12452) 2024-06-25 09:42:31 +02:00
dependabot[bot]
a0610f4f33
Bump mypy from 1.10.0 to 1.10.1 (#12475) 2024-06-25 09:37:05 +02:00
James Addison
6b237d9a70
[linkcheck] Allow integer for linkcheck_rate_limit_timeout (#12470) 
Eliminate type-related warnings when users configure a valid integer value for the `linkcheck_rate_limit_timeout` config setting.

Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
 2024-06-24 17:26:24 +00:00
Rafael Fontenelle
2ccae70089
[docs] Fix typos in autodoc.rst (#12469) 2024-06-24 14:48:54 +02:00
James Addison
d42db153df
[ci] Ensure files within tests/js trigger NodeJS tests (#12445) 
Ensure that any changes to the JS tests,
introduced in PR/commit pushes,
re-runs the relevant GitHub Actions workflow.
 2024-06-23 00:23:04 +02:00
Chris Sewell
53119133f2
[docs] Keep top-bar visible (#12464) 
This commit ensures the top-bar is always visible, rather than being hidden on scrolling or navigating to a target.
 2024-06-23 00:19:43 +02:00
Tim Hoffmann
be92d6545a
DOC: Reduce horizontal padding on small screens (#12465) 
Maximize used horizontal space when the screen is small.
 2024-06-23 00:04:52 +02:00
Chris Sewell
a1bb165685
[docs] Add Github repo icon-link to topbar (#12462) 
Add a link to sphinx-doc/sphinx, via an icon on the right of the top-bar
 2024-06-22 20:48:18 +02:00
Chris Sewell
bcf32428c8
[docs] Improve sidebar (#12461) 
- Remove "Site navigation" header
  - this is already contextually clear (especially since separators were added in #12439)
- Hide "On this page" if `display_toc is False`
- Format "On this page" header similar to top-level site-nav sections
 2024-06-22 15:32:06 +02:00
Chris Sewell
c5bd2d42c5
[docs] improve RTD version selector (#12460) 
ensure the border-radius is applied correctly
 2024-06-22 14:50:38 +02:00