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
18,162 Commits 2 Branches 219 Tags
51e7b6d2aa871c262e37f3fc9edbef67a2b3edd2
Commit Graph

3290 Commits

Author SHA1 Message Date
Jakob Lykke Andersen
a6246c1b65 Typo fixes 2021-10-01 20:48:12 +02:00
Jakob Lykke Andersen
91d0289009 C++, add retval info field to cpp:function 2021-10-01 20:47:14 +02:00
Jakob Lykke Andersen
57fad5c044 C, update documentation for info-fields 2021-10-01 18:38:30 +02:00
Ghassan Maslamani
d20646194c doc: update description 
Update description about how `conf.py` is loaded/executed
 2021-09-30 13:43:09 +03:00
Takeshi KOMIYA
c0333d4464 Merge pull request #9666 from tk0miya/9662_docs_for_ObjectDescription 
Add doc for ObjectDescription (refs: #9662)
 2021-09-27 01:57:36 +09:00
Takeshi KOMIYA
de59a72fe6 Merge pull request #9665 from tk0miya/9664_autodoc_process_bases_injection 
Close #9664: autodoc: autodoc-process-bases supports reST snippet
 2021-09-26 00:54:42 +09:00
Takeshi KOMIYA
9543962da6 Add doc for ObjectDescription (refs: #9662) 2021-09-23 12:56:09 +09:00
Takeshi KOMIYA
d13b86e02f Close #9664: autodoc: autodoc-process-bases supports reST snippet 
This allows to inject a reST snippet through autodoc-process-bases
event.  It helps to modify the base classes of any class to the expected
mark-up'ed text by custom extension.
 2021-09-23 10:59:01 +09:00
Takeshi KOMIYA
29ac4c1982 Fix #9637: Add Builder.allow_parallel to the list of builder APIs 2021-09-18 01:26:12 +09:00
Takeshi KOMIYA
260f217a3d Merge pull request #9594 from hkuno/pr/no_empty_desc_4.x 
let user skip printing command description
 2021-09-11 19:08:37 +09:00
Takeshi KOMIYA
8416813168 Merge pull request #9616 from jdufresne/fix-url 
Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g
 2021-09-11 17:16:47 +09:00
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +02:00
Jon Dufresne
7dd112b110 Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g 
https://sphinx-doc.org is unreachable, but is linked from the PyPI page:
https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/
instead.
 2021-09-06 13:15:48 -07:00
Harumi Kuno
d0e014b4bc Omit NAME section if blank description 
Also, update man page for configuration to document that
if a blank description is entered, the "NAME" section is an
empty string.

Signed-off-by: Harumi Kuno <harumi.kuno@hpe.com>
 2021-09-05 17:42:03 -07:00
Takeshi KOMIYA
12cf4ebc1f Merge pull request #9545 from aaugustin/4.x 
Update link to OpenSearch.
 2021-08-14 22:37:34 +09:00
Aymeric Augustin
56add529ec Update link to OpenSearch. 
Amazon repurposed the opensearch.org domain.

It is now hosting their ElasticSearch fork.
 2021-08-14 11:49:34 +02:00
Kevin Anderson
cfd5536b27 fix typo in numfig_format default value 2021-08-13 07:20:16 -06:00
Juan Luis Cano Rodríguez
f152680bfb Split tutorial in several files 2021-08-11 13:31:47 +02:00
Takeshi KOMIYA
8948f45226 Merge pull request #9527 from tk0miya/9525_tutorial 
Fix #9525: tutorial: Wrong condition in recipe.py
 2021-08-11 02:14:12 +09:00
John Cole
8dbef8798a Fix typo 2021-08-04 20:28:45 -04:00
Takeshi KOMIYA
c1692faba7 Fix #9525: tutorial: Wrong condition in recipe.py 2021-08-05 01:38:58 +09:00
Takeshi KOMIYA
641174db5d Merge pull request #9447 from Blendify/Blendify/html-templates-sphinx-version 
HTML Templates: Expose full sphinx version tuple
 2021-08-02 02:08:50 +09:00
Takeshi KOMIYA
6e87c17a76 doc: Add document for autoproperty directive (refs: #9486) 2021-07-23 23:10:48 +09:00
Takeshi KOMIYA
362f36d35d Merge pull request #9461 from tk0miya/9445_class_property 
Close #9445: Support class properties
 2021-07-20 01:12:04 +09:00
Takeshi KOMIYA
445c340cbd Merge pull request #9474 from jfbu/latex_document_9166 
LaTeX: add some documentation for container support (#9166)
 2021-07-20 01:00:28 +09:00
Takeshi KOMIYA
0e5dab0dc1 Merge branch '4.1.x' into 4.x 2021-07-20 00:59:03 +09:00
jfbu
e1612b4909 Remove mark-up breaking PDF output 
Close: #9475

Refs: #9355
 2021-07-19 12:23:30 +02:00
jfbu
af5363cefb LaTeX: add some documentation for container support (#9166) 2021-07-19 12:10:15 +02:00
usaturn
c56a37e4d5 fix link of code of conduct 2021-07-17 17:38:27 +09:00
Takeshi KOMIYA
120525563c Cloase #9445: :py:property: directive now supports :classmethod: option 
Since python 3.9, `classmethod` starts to support creating a "class
property".  This allows to describe it.
 2021-07-17 14:24:31 +09:00
Aaron Carlisle
426fdcabcd HTML Templates: Expose full sphinx version tuple 
Previously, there was only a string which is problematic
when you want to programmatically compare versions
for compatibility reasons.
 2021-07-13 20:44:46 -04:00
Takeshi KOMIYA
7e3e15231e Merge pull request #9419 from zhsj/fancyvrb-zh 
Add xeCJKVerbAddon to default fvset config for Chinese documents
 2021-07-11 01:43:44 +09:00
Shengjing Zhu
92c9cabae5 Add xeCJKVerbAddon to default fvset config for Chinese documents 
Prevent xeCJK from adding extra spaces in fancyvrb Verbatim enviroment.

Fixes: #9414

Signed-off-by: Shengjing Zhu <i@zhsj.me>
 2021-07-09 01:53:52 +08:00
Eisuke Kawashima
652ebf1bf5 Fix typo 2021-07-08 08:16:22 +09:00
Takeshi KOMIYA
5e5bca98f7 Merge branch '4.x' into 6525_linkcheck_warn_redirects 2021-07-07 02:09:50 +09:00
Takeshi KOMIYA
5ce5f40402 Merge pull request #9340 from ocket8888/patch-1 
Update example to use recommended usage
 2021-07-07 01:50:34 +09:00
Juan Luis Cano Rodríguez
b9da1577b6 Merge branch '4.x' into new-tutorial-part-ii 2021-07-05 20:12:53 +02:00
Juan Luis Cano Rodríguez
cb846a39e0 Add link to docutils docs 2021-07-05 09:39:14 +02:00
Juan Luis Cano Rodríguez
6f9bc6e7e5 Use "builtin" for extensions label as it is done for themes 2021-07-05 09:32:10 +02:00
Juan Luis Cano Rodríguez
f303a4a9ed Consistent use of "rst" for syntax highlight 2021-07-05 09:25:05 +02:00
Juan Luis Cano Rodríguez
50bd1c3967 Remove unnecessary label 2021-07-05 09:22:14 +02:00
Juan Luis Cano Rodríguez
74e565f99b Consistent use of "build documentation" 2021-07-05 09:21:55 +02:00
Juan Luis Cano Rodríguez
d5f452a81f Remove redundant local table of contents 2021-07-05 09:12:40 +02:00
Juan Luis Cano Rodríguez
13831572d5 Keep old name for root document in the glossary 2021-07-05 09:11:47 +02:00
Takeshi KOMIYA
2100722b70 Merge pull request #9353 from astrojuanlu/fix-extensions-link 
Fix link to third-party extensions in front page
 2021-07-04 23:58:54 +09:00
Takeshi KOMIYA
0ee0d8df00 Merge pull request #9399 from tk0miya/napoleon_preprocess_types 
doc: Fix the default value of napoleon_preprocess_types is True
 2021-07-04 11:26:43 +09:00
Takeshi KOMIYA
e8ba4f1803 Merge pull request #9392 from LouisJustinTALLOT/patch-1 
Fix quotes in docstring in ext.napoleon
 2021-07-03 20:10:55 +09:00
Takeshi KOMIYA
f6b3f36e23 doc: Fix the default value of napoleon_preprocess_types is True 2021-07-03 17:41:57 +09:00
Frank Yu
da00466081 Update docs for theming 2021-07-03 00:44:10 +08:00
Louis-Justin TALLOT
a52ccdbfc7 Fix quotes in docstring in ext.napoleon 2021-06-30 19:40:35 +02:00