IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-10-25 22:50:22 -05:00
Code Issues Packages Projects Releases Wiki Activity
22,422 Commits 4 Branches 238 Tags
479428338eb86b6fe2984ef22eee1f73269f9cb4
Commit Graph
597 Commits
Author SHA1 Message Date
Jared DillardandAdam Turner b127b9478a Add `app.add_static_dir()` for copying extension static files (#14219) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2025-12-31 14:58:12 +00:00
Shengyu Zhang 37ceb97e72 Fix typo in "source-read" event parameter description (#14211) 2025-12-24 16:16:30 +00:00
Adam Turner 1e5f2f9913 Improve event manager API documentation (#14122) 2025-11-30 00:02:39 +00:00
Adam Turner 45e1ae646c Remove deprecated API (#14095) 2025-11-25 20:15:39 +00:00
Adam Turner f1edefee45 Deprecate the `sphinx.io` module (#13682) 2025-06-19 11:53:44 +01:00
Adam Turner 0b0c039c02 Deprecate remaining public `app` attributes (#13627) 2025-06-07 01:34:48 +01:00
Victor Wheeler ad360fd634 Fix parameter lists for two event callback functions (#13516) 2025-05-21 02:34:39 +01:00
Yuki KobayashiandAdam Turner 491999f569 Docs: Fix `nested_parse` sample code (#13455) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2025-05-13 10:52:55 +01:00
Matthias GeierandAdam Turner 94563a398b Un-deprecate `sphinx.util.import_object` (#13330) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2025-02-11 19:07:27 +00:00
Adam Turner d42cfa702f Further minor copyediting of the 'extension metadata' section 2025-01-10 01:26:17 +00:00
Adam Turner daade2715a Rewrite the 'extension metadata' section 2025-01-10 01:09:49 +00:00
Adam Turner e65bbb96ae Create a new type for the current document's environment state (#13151) 2025-01-04 00:28:03 +00:00
James AddisonandAdam Turner c93723b803 singlehtml: deprecate the 'fix_refuris' helper function (#13037) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-11-13 23:15:00 +00:00
Tim Hoffmann 20b53bcc1a Add a graph illustrating the build phases to the docs (#13108) 2024-11-13 22:22:47 +00:00
Santos Gallegos 2320c46b9e Document `Sphinx.set_html_assets_policy` (#13123) 2024-11-13 22:10:03 +00:00
Adam Turner 801c60a873 Consistently calculate the current file's directory 2024-11-03 17:28:02 +00:00
Adam Turner 116a430cac Accept PathLike in Sphinx.add_message_catalog() 2024-10-25 22:49:51 +01:00
Tim HoffmannChris SewellAdam Turner
 		b6269d3790 Improve documentation for the Builder API (#13008) 
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-10-12 00:21:34 +01:00
Chris Sewell c23697aaa7 Use method colour key in the Builder API graph (#12998) 2024-10-11 22:51:32 +01:00
Adam Turner d135d2eba3 Mark `Builder.write()` as final (#12767) 2024-10-10 15:59:12 +01:00
Tim HoffmannandAdam Turner 6cf3f9238e Consistently use sentence case for headings (#12987) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-10-08 23:04:18 +01:00
James KnightandAdam Turner d1c4480f2a Allow builders to override support for linkcode references (#12852) 
Signed-off-by: James Knight <james.d.knight@live.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-10-06 22:54:02 +01:00
Tim HoffmannandAdam Turner b16e196a60 Improve `autodoc` docs (#12935) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-10-02 23:02:48 +00:00
Shengyu ZhangandAdam Turner d347149f55 Document `sphinx.domains.IndexEntry` (#12820) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2024-09-02 10:30:49 -05:00
Wei-Hsiang (Matt) Wang e35e7b0fbe Remove unnecessary `:func: and :meth:` parentheses (#12848) 2024-09-01 06:33:28 +01:00
Adam DangoorandAdam Turner cb455ddada Add per-event overloads to `Sphinx.connect()` (#12784) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-08-15 21:49:50 +01:00
Adam Turner be73e64a9f Add `sphinx.util._files` (#12766) 2024-08-11 19:51:59 +01:00
nikkie c6163ff442 Fix a typo in `extdev/testing.rst` (#12765) 2024-08-11 17:57:46 +01:00
Adam Turner d39ba32604 Add `sphinx.util._importer` (#12762) 2024-08-11 17:24:26 +01:00
Adam Turner fc808e0e90 Expand the `sphinx.testing` overview 2024-07-24 15:21:14 +01:00
Adam Turner 3b14b56939 Move the `sphinx.testing` overview to the API section 2024-07-24 15:21:14 +01:00
Adam Turner 772cdfa19d Remove `sphinx.directives.other.VersionChange` (#12662) 2024-07-23 14:56:49 +01:00
Adam Turner e174df2762 Rename `normalize_intersphinx_mapping to validate_intersphinx_mapping` (#12643) 2024-07-22 13:32:44 +01:00
Adam Turner aeebfabe09 Add `include-read to the events overview; sort core_events` (#12576) 2024-07-15 05:06:26 +01:00
Chris SewellandAdam Turner d8fa98e46a Add a `write-started` event (#12567) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-15 04:59:06 +01:00
Adam Turner 1252c7b549 Use "rst" consistently for code and highlighting directives 2024-07-15 02:15:52 +01:00
Adam Turner f2640a4286 Standardise on "reStructuredText" over "reST" in documentation 2024-07-15 02:15:52 +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 b5b383fd47 Rewrite the "Docutils markup API" page (#12505) 2024-07-03 02:09:15 +01: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 8f97fd276a [docs] Improve landing page (#12453) 
This commit is intended to improve new user's first-interaction with the Sphinx site:

- Make page header icon/text smaller and not capitalized
- Give min-width to left sidebar (it was getting too small at certain window sizes)
- Replace features list on landing page with admonition boxes, with adaptive layout
- Add landing page "used by" section
- Slightly restructure the Extension section, into Tutorials and How-tos
- Add code to `conf.py` to write HTML write redirect pages for moved documents
- Improve support page, by adding link to Stackoverflow, GH discussion and ReadtheDocs,
  and remove defunct link to libera chat and matplotlib tutorial
 2024-06-21 20:12:57 +02:00
Chris Sewell 11abfb90ba [docs] Update changelog (#12454) 
Some additions to the changelog,
that were not added in the relevant PRs.
 2024-06-21 15:48:59 +02:00
Chris SewellandBénédikt Tran 0e3f5b4ab2 [DOCS] Improve events (#12446) 
Split the events callback API into a separate document, add a flow graph of the events within the build process, add parameters to the events,
and link the `EnvironmentCollector` docs to the relevant events.

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
 2024-06-20 10:40:22 +02:00
Chris Sewell 37ff33dff7 [builder] type Builder core methods with @final and improve docs (#12436) 
This commit:

- annotates the `Builder`'s "core" methods, with [`final`](https://docs.python.org/3/library/typing.html#typing.final)
- adds a UML graph to the Builder API docs
- Adds more methods to the Builder API docs

to make it clearer for extension developers, what is expected from a new builder subclass.
 2024-06-19 14:51:20 +02:00
Rafael Fontenelle 20ec3bd69d [docs] fix a typo in `markupapi.rst` (#12413) 2024-06-06 12:52:31 +02: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 SewellandBénédikt Tran 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
Bénédikt Tran b2069fb64f [lint] update Makefile and lint doc (#12117) 2024-03-17 14:45:56 +01:00
Adam Turner 259118d182 Narrow the type for configuration option 'valid_types' values 2024-01-03 21:51:39 +00:00
Adam Turner 9d1dcae373 Deprecate old-style Makefiles in sphinx-quickstart (#11693) 2023-09-21 10:25:00 +01:00