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
21,242 Commits 2 Branches 219 Tags 163 MiB
3d49941484
Commit Graph

187 Commits

Author SHA1 Message Date
Adam Turner
3b14b56939 Move the `sphinx.testing` overview to the API section 2024-07-24 15:21:14 +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
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
Adam Turner
670bcb743b
Documentation reshuffle (#11112) 2023-01-08 13:52:36 +00:00
Adam Turner
ee005caf22 Do not apply epigraph style to all block quotes 
Correct indentation where appropriate for stanzas that should not be
rendered as `<blockquote>` HTML elements.

Closes GH-10686
 2022-09-12 19:54:36 +01:00
Takayuki SHIMIZUKAWA
068f802df9
fix typo 
from https://github.com/sphinx-doc/sphinx-doc-translations/pull/13
 2022-04-19 04:10:39 +09:00
Eisuke Kawashima
652ebf1bf5
Fix typo 2021-07-08 08:16:22 +09:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS 
Also change any docutils.sourceforge.net link to io
top level domain.
 2021-05-16 15:53:49 +03:00
Takeshi KOMIYA
02016c0ef2 Close #8829: doc: Update description of paralle-read-safe 2021-04-04 13:35:12 +09:00
Chris Holdgraf
60b105d6aa several documentation improvements to theming, templating, and extension development 2020-07-29 10:38:18 +01:00
Takeshi KOMIYA
a5dadeb890 Fix #7418: std domain: duplication warning for glossary terms is case insensitive 2020-04-09 01:56:13 +09:00
Takeshi KOMIYA
d6063ff35b doc: Fold lines by 80 columns 2019-05-30 01:07:05 +09:00
Takeshi KOMIYA
fa00458f4f docs: Fold lines by 80 chars 2019-05-12 17:57:38 +09:00
Takeshi KOMIYA
2606002bb4
Merge pull request #6125 from tk0miya/doc-enhance_extension_dev_i18n 
doc: Enhance documentation about internalization of external extension (refs: #5991)
 2019-03-10 01:16:06 +09:00
Takeshi KOMIYA
d4ac7217a8 Move list of deprecated API to extdev/deprecated.rst 2019-03-09 19:32:24 +09:00
Takeshi KOMIYA
4ca5924d49
Merge pull request #6129 from tk0miya/refactor_util.nodes 
Refactor util.nodes
 2019-03-07 01:20:06 +09:00
Takeshi KOMIYA
259c2bb8a6 refactor: Rename find_source_node() to get_node_source() 2019-03-03 14:42:23 +09:00
Takeshi KOMIYA
4b15b6659f Move ext-i18n section to extdev/i18n.rst 2019-03-02 19:04:24 +09:00
Takeshi KOMIYA
ea1eec75dc Merge branch 'master' into doc-enhance_extension_dev_i18n 2019-03-02 19:00:25 +09:00
Takeshi KOMIYA
0d7bc86e7b refactor: move NoUri to sphinx.errors 2019-03-02 16:21:44 +09:00
Takeshi KOMIYA
8d0d75fea7
Merge pull request #6110 from tk0miya/refactor_catalog 
Refactor catalog detection and compilation
 2019-02-27 23:36:14 +09:00
Takeshi KOMIYA
fb8838ee53 refactor: Use CatalogRepository instead of find_catalog_source_file() 2019-02-27 22:47:08 +09:00
Takeshi KOMIYA
5f8f902b63 Rename find_catalog() to docname_to_domain() 2019-02-27 21:44:16 +09:00
Takeshi KOMIYA
af51e9825a refactor: Move implementation of mock to sphinx.ext.autodoc.mock 2019-02-27 21:42:23 +09:00
Takeshi KOMIYA
19b52c6eaa Replace :autolink: roles by class based implementation 2019-02-27 16:02:49 +09:00
Takeshi KOMIYA
1ca210aab1 Separate json and pickle to sphinxcontrib package 2019-02-17 22:31:50 +09:00
Takeshi KOMIYA
3ec032fa39 Replace :file: and :samp: roles by class based implementation 2019-02-16 12:37:46 +09:00
Takeshi KOMIYA
ea4d8ca08d Replace :guilabel: and :menuselection: roles by class based implementation 2019-02-16 02:30:28 +09:00
Takeshi KOMIYA
9cb40436ed Replace :pep: and :rfc: roles by class based implementation 2019-02-16 00:34:24 +09:00
Takeshi KOMIYA
a6d345f95d Replace :index: role by class based implementation 2019-02-16 00:05:13 +09:00
Takeshi KOMIYA
3b49f9fe3d Separate htmlhelp to sphinxcontrib package 2019-02-15 01:44:32 +09:00
Takeshi KOMIYA
549a763195
Merge pull request #6025 from tk0miya/refactor_roles2 
Introduce SphinxRole class as a base class of roles
 2019-02-14 01:09:28 +09:00
Takeshi KOMIYA
2efc1065c0 Deprecate sphinx.util.pycompat:sys_encoding 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
b25deb259e refactor: Move NoneType to sphinx.util.typing 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
d40ce68c7b refactor: Move terminal_safe() to sphinx.util.console 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
ac70a4dd91 Replace :abbr: role by class based implementation 2019-02-06 01:20:58 +09:00
Takeshi KOMIYA
c4397318d3 Separate applehelp to sphinxcontrib package 2019-02-06 00:44:37 +09:00
Vincent Férotin
98fd02e262 doc: Enhance documentation about internalization of external extension. 2019-01-28 15:48:50 +01:00
Takeshi KOMIYA
2bd69350a7 Separate devhelp to sphinxcontrib package 2019-01-20 03:03:50 +09:00
Takeshi KOMIYA
6be9d2a08e Separate qthelp to sphinxcontrib package 2019-01-19 16:34:06 +09:00
Takeshi KOMIYA
20bf74c637 Separate jsmath to sphinxcontrib package 2019-01-13 14:07:12 +09:00
Takeshi KOMIYA
6429c9e23c
Merge branch 'master' into refactor_singlehtml 2019-01-12 21:17:16 +09:00
Takeshi KOMIYA
8b6acc05c4
Merge pull request #5909 from tk0miya/refactor_epub2 
refactor: Convert Epub3Builder.validate_config_values() to a function
 2019-01-12 18:22:00 +09:00
Takeshi KOMIYA
354e765eef refactor: Convert Epub3Builder.validate_config_values() to a function 2019-01-12 18:05:28 +09:00
Takeshi KOMIYA
b08a7c4757 Move SingleFileHTMLBuilder to sphinx.builders.singlehtml package 2019-01-11 01:59:56 +09:00
Takeshi KOMIYA
e82f5ddb55 The arguments of Epub3Builder.build_navigation_doc() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
b6c422ac86 The arguments of EpubBuilder.build_epub() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
64533e142c The arguments of EpubBuilder.build_toc() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
d437f39bc4 The arguments of EpubBuilder.build_content() is deprecated. 2019-01-09 00:10:36 +09:00