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,738 Commits 2 Branches 219 Tags
254bfe4f4e374880f9110adb94f1f5203d0757af
Commit Graph

3786 Commits

Author SHA1 Message Date
Adam Turner
254bfe4f4e Add `theme.toml` migration tool 2024-04-11 19:01:17 +01:00
Adam Turner
8976fa4498 Support `theme.toml` 2024-04-11 19:01:17 +01:00
Dimitri Papadopoulos Orfanos
6caf4ee17e Reduce size of PNG files in the tutorial (#12245) 2024-04-11 16:26:06 +01:00
Adam Turner
9ebfadbcad Create subsection for theme configuration 2024-04-09 18:34:55 +01:00
Adam Turner
e3f0aa9307 Ensure raw strings are used for regular expression patterns 2024-04-09 18:33:42 +01:00
Nok Lam Chan
17a84a6443 [doc] clarify units for `linkcheck_rate_limit_timeout` (#12225) 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

This normalizes the description of the configuration value so that its default value's unit is the same as the internal one (i.e., seconds).
 2024-04-05 11:51:02 +02:00
Bénédikt Tran
f44ff30673 [doc] cleanup references and update external URLs (#12182) 2024-03-25 11:39:05 +01:00
Bénédikt Tran
f24eef7b6b [cleanup] deprecate `sphinx.testing.util.strip_escseq in favor of sphinx.util.console.strip_colors` (#12186) 2024-03-24 00:43:54 +01:00
Chris Sewell
d59b158371 👌 Make ExtensionMetadata type public and use it in internal extensions (#12153) 
This type alias has now been fully documented for public consumption.

This will be beneficial to the sphinx ecosystem,
to aide/encourage extension developers to provide the correct metadata.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-03-21 16:19:26 +01:00
Chris Sewell
b45fee696f 🔧 Sync make doclinter with CI check (#12156) 
Unignore files in `make doclinter` command, fix the resulting issues, and use this command in the CI job
 2024-03-21 13:12:06 +01:00
Chris Sewell
d908886c03 📚 add tip about running karma js tests on mac (#12140) 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-03-20 21:55:34 +01:00
Chris Sewell
3bedde26a9 🔧 Ruff format python files within docs folder (#12139) 
Remove `docs` files from the `exclude` list, and also add the `preview = false` format config, which is shown to reduce diffs to the current code base
 2024-03-19 15:23:57 +01:00
James Addison
d93223a886 docs: add reference to templating from theme development. (#12056) 
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
 2024-03-19 14:43:42 +01:00
Chris Sewell
565d4104d5 👌 Handle external references pointing to object types (#12133) 
This commit fixes the issue of `objects.inv` denoting object names, whilst the `external` role only allows for role names. 

As an example, take the `objects.inv` for the sphinx documentation, which contains:

```
py:function
    compile                  : usage/domains/python.html#compile
```

A user might understandably expect that they could reference this using `` :external:py:function:`compile` ``, but actually this would previously error with:

```
WARNING: role for external cross-reference not found: py:function
```

this is because, `function` is the object type, yet `external` expects the related role name `func`.

It should not be necessary for the user to know about this distinction,
so in this commit, we add logic, to first look if the name relates to a role name (as previous, to not be back-breaking) but, if not, then also look if the name relates to an object that has a known role and, if so, use that.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-03-19 13:42:50 +01:00
Chris Sewell
b0f096f440 ✨ Add show_warning_types configuration variable (#12131) 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-03-19 10:22:28 +01:00
Bénédikt Tran
b2069fb64f [lint] update Makefile and lint doc (#12117) 2024-03-17 14:45:56 +01:00
Alexandre Franke
1281b158b4 Fix typos in usage/configuration.rst (#12024) 2024-03-07 20:50:46 +01:00
Jared Dillard
fde43ed8b4 [docs] clarify the proper 'make-mode' usage in the docs (#11992) 2024-02-27 09:03:15 +01:00
Demetrios Koziris
faa33a53a3 [docs] Clarify how to escape curly braces in `samp` text (#11987) 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-02-22 09:48:12 +01:00
Harrissou Sant-anna
f4eea669e0 Fix wording for the number of default substitutions (#11985) 2024-02-19 10:14:07 +01:00
Dimitri Papadopoulos Orfanos
4f08cdff13 Enable the FURB113 rule in Ruff (#11856) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: danieleades <33452915+danieleades@users.noreply.github.com>
 2024-01-21 20:25:05 +00:00
danieleades
f9c8943889 Use `# NoQA` consistently (#11903) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-01-21 20:20:58 +00:00
Hugo van Kemenade
95b2cce9a0 Add a `versionremoved` directive (#11905) 
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-01-21 20:12:52 +00:00
pcgaustad
2ccc9d315e Give a more plausible example for a combination of tags (#11899) 2024-01-20 19:10:23 +00:00
Nicolas Peugnet
59cf4d4c35 Allow custom targets in the manpage role (#11825) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-01-17 01:09:18 +00:00
danieleades
f7fbfaa471 Enable various pydocstyle (D) rules (#11878) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-01-14 21:13:46 +00:00
Adam Turner
587e01177d Provide example interface for ``Scorer` 2024-01-14 04:47:44 +00:00
Adam Turner
23cef9b59a Use `https://` where possible 2024-01-14 04:18:57 +00:00
James Addison
2b47fd4b4b Update linkcheck_timeout value and documentation (#11875) 2024-01-13 17:41:28 +00:00
Alex Szatmary
bcb1825679 State that `exclude_patterns` has priority (#11872) 2024-01-12 04:28:47 +00:00
James Addison
5211c01646 Enable reporting HTTP 401 hyperlinks as broken in linkcheck (#11684) 
Co-authored-by: picnixz <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-01-09 12:33:40 +00:00
Dimitri Papadopoulos Orfanos
460a63010f Fix various spelling errors (#11735) 2024-01-04 02:37:44 +00:00
Adam Turner
259118d182 Narrow the type for configuration option 'valid_types' values 2024-01-03 21:51:39 +00:00
Adam Turner
cb9656f654 Update all GitHub Actions versions 2024-01-03 03:31:39 +00:00
Rex Yuan
23c9cb4e78 [docs] Fix Makefile target in describing-code.rst (#11428) 2023-12-30 14:48:16 +01:00
Shengyu Zhang
9c3b50b31c Avoid hard-coding 'index' for the master document in templates (#11801) 2023-12-28 07:05:14 +00:00
Hugo van Kemenade
aea69ea6af Add longer option names to `sphinx-build` (#11776) 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2023-12-27 00:22:52 +00:00
Adam Turner
5730329d83 Simplify the font selection 2023-10-04 16:56:47 +01:00
Adam Turner
8878bee000 Replace the header image with a new SVG logo 2023-10-04 16:56:46 +01:00
Adam Turner
3d8b00827e Promote underline levels 2023-10-03 19:39:36 +01:00
Adam Turner
81a8870eee Note that cross-referencing syntax has moved to a new location 2023-10-03 19:39:36 +01:00
Adam Turner
6a56592b30 Move cross-referencing to a new page 2023-10-03 19:32:37 +01:00
Adam Turner
909f93c7ec Use `pyproject.toml entry points rather than setup.py` 2023-10-03 19:26:37 +01:00
Adam Turner
5d58624227 Reformat the domains lists 2023-10-02 13:10:26 +01:00
Adam Turner
f7f41e6828 Fix and standardise markup 2023-10-02 13:10:26 +01:00
Adam Turner
3dd10e47d0 Add versionadded directives 2023-10-02 13:10:26 +01:00
Adam Turner
e15fc04e53 Promote underline levels 2023-10-02 13:10:26 +01:00
Adam Turner
385a9193a7 Remove redundant labels 2023-10-02 13:10:26 +01:00
Adam Turner
607aadc660 Split out the Maths domain 2023-10-02 13:10:26 +01:00
Adam Turner
c6dd47d2c8 Split out the reStructuredText domain 2023-10-02 13:10:26 +01:00