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,961 Commits 2 Branches 219 Tags 163 MiB
aa6dac81ec
Commit Graph

20961 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Jean-François B
aa6dac81ec
LaTeX: Revamp the styling of all admonitions (#12508) 
In LaTeX output, all admonitions now also have a title row with icon.

The ``xcolor`` LaTeX package is now required and the ``fontawesome5`` LaTeX package is needed for the icons.
 2024-07-13 17:33:22 +01:00
Jean-François B
e49e2933bb
LaTeX: Use the babel LaTeX package by default for 'lualatex' with French (#12557) 
Previously ``polyglossia`` was used by default.
 2024-07-13 09:02:43 +01:00
Adam Turner
469a809ead
Increase minimum required dependency versions (#12556) 2024-07-13 08:59:24 +01:00
Adam Turner
d2f426637d
Require Docutils 0.20 or greater (#12555) 2024-07-13 08:20:13 +01:00
Adam Turner
063c97304d
Simplify the type of configuration value descriptions (#12553) 
There's no real reason to have the empty string as a description, 
and hence we can just make the type ``str`` rather than a union.
 2024-07-13 07:35:39 +01:00
Adam Turner
3b19a7b4ba Add missing `docutils` warning type in the documentation 2024-07-13 07:16:58 +01:00
Trevor Bekolay
2c0943784c
Disallow module cycles in autosummary (#6792) 
Consider the following piece of reST::

  .. automodule:: sphinx.ext.autosummary
     :members:

     .. autosummary::

        sphinx.ext.autosummary.Autosummary

This inserts an autosummary after the module docstring, but before
the members of the module. Without the change in this commit, this
would fail because `import_by_name` would attempt to import::

    sphinx.ext.autosummary.sphinx.ext.autosummary.Autosumary

because the prefix (from the parent) is `sphinx.ext.autosummary`,
and the name is `sphinx.ext.autosummary.Autosummary`, which is able
to be imported from `sphinx.ext.autosummary`, but is not the way
that anyone would want to refer to it.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-07-13 06:37:50 +01:00
Chris Sewell
78c8b4d323
Add optional description argument to app.add_config_value (#12549) 
Sphinx (+ extensions) has a lot of available configuration variables for users,
allowing for the co-location of a short description on the configuration value,
can be utilised by external tools to provide better sphinx authoring support.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-07-12 19:40:36 +02:00
Chris Sewell
316451de81
Add docutils type, to warnings originating from docutils (#12550) 
As per other warning types, this helps users to better understand the root of the problem.
 2024-07-12 19:02:44 +02:00
Rafael Fontenelle
9234d0b08d
Add missing backtick to close literal role in configuration.rst (#12547) 2024-07-11 21:29:52 +01:00
alvinhochun
41ee3be2cc
Do not add a language fallback by the stripping country code (#9635) 2024-07-11 12:46:28 +01:00
James Addison
a6c2bdd371
Rename template files in Sphinx to use the `.jinja` extension (#12364) 2024-07-11 12:31:35 +01:00
Ashley Whetter
e38a60d3f2
Add `py:type` directive and role for documenting type aliases (#11989) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-11 12:15:54 +01:00
James Addison
91c5cd3abd
Improve relevance scoring in HTML search results (#12441) 
Co-authored-by: Will Lachance <wlach@protonmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-07-11 11:55:40 +01:00
Adam Turner
e7beb8bc5c
Remove dead class attributes (#12545) 2024-07-11 08:34:57 +01:00
Stephen Finucane
6b37a6b2a2
Allow explicitly specifying modules in the coverage builder (#11592) 
Currently there is no mechanism to identify totally undocumented modules
in the coverage builder, unlike with partially documented modules.
Resolve this by introducing a new ``coverage_modules`` config option.
This is a list of modules that should be documented somewhere
within the documentation tree. 
Any modules that are specified in the configuration value but 
are not documented anywhere will result in a warning. 
Likewise, any modules that are not in the config option but 
are documented somewhere will result in a warning.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2024-07-11 07:36:36 +01:00
Adam Turner
3d118ce81c
Simplify `make_filename_from_project` (#12540) 2024-07-11 06:57:47 +01:00
Adam Turner
81832c2efc
Refactor `is_suppressed_warning` to use set lookups (#12539) 2024-07-11 06:57:26 +01:00
M Bussonnier
602bfe4255
Bump `types-docutils` to 0.21.0.20240711 (#12529) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-11 06:55:58 +01:00
Thomas Fanning
6cc1177d10
Allow configuring the separator used in numbering equations (#12523) 
Co-authored-by: Thomas Fanning <tom@ferb.ne.anl.gov>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-10 22:23:38 +01:00
Adam Turner
82edc3d385
Rewrite `usage/configuration.rst` (#12537) 
- Remove now-removed configuration values
- Use obvious 'unset' defaults for ``project`` and ``author``
- Prefer 'e.g.' to 'ex.'
- Allow non-list sequence types in various configuration values
- Add types and defaults to every confval directive
 2024-07-10 21:43:14 +01:00
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