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,243 Commits 2 Branches 219 Tags
be36cf471b50739e3a686ea69db3db3d99aba2f2
Commit Graph

658 Commits

Author SHA1 Message Date
Takeshi KOMIYA
be36cf471b Merge pull request #9679 from latosha-maltba/doc/directive-indent 
Document indent behaviour for directives
 2021-10-09 16:26:52 +09:00
Takeshi KOMIYA
481c5e9c4b Merge pull request #9534 from astrojuanlu/new-tutorial-describing-code 
New Sphinx tutorial, part III
 2021-10-09 13:05:48 +09:00
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
Latosha Maltba
ee3f361992 Document indent behaviour for directives 
Mention how the indent of the contents for directives is chosen and what
the effect on directives which are sensitive to whitespace is,
e.g. code-block.
 2021-09-27 09:06:52 +00: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
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
a606db01f1 Add section on autosummary 2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
2c1fa831c1 Add tutorial section on documenting Python objects 2021-08-12 20:06:56 +02:00
John Cole
8dbef8798a Fix typo 2021-08-04 20:28:45 -04:00
Takeshi KOMIYA
6e87c17a76 doc: Add document for autoproperty directive (refs: #9486) 2021-07-23 23:10:48 +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
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
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
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
Louis-Justin TALLOT
a52ccdbfc7 Fix quotes in docstring in ext.napoleon 2021-06-30 19:40:35 +02:00
Takeshi KOMIYA
ec351bdf3d Merge branch '4.0.x' into 4.x 2021-06-30 21:24:06 +09:00
Juan Luis Cano Rodríguez
c9d2a73d93 Rename to root document 2021-06-22 15:27:54 +02:00
Juan Luis Cano Rodríguez
3fcaa172db Move reference to list of Pygments lexers 2021-06-21 07:38:51 +02:00
Jakob Lykke Andersen
50f5280603 C, keyword changes 
- Add new keywords from C23.
- Add c_extra_keywords as confval.
- Move macro names from keywords to c_extra_keywords.

Fixes sphinx-doc/sphinx#9354
 2021-06-17 08:29:39 +02:00
Juan Luis Cano Rodríguez
57b0a1b465 Add section about the toctree 2021-06-17 00:31:53 +02:00
Juan Luis Cano Rodríguez
1e49218993 Add tutorial section about extensions and themes 2021-06-17 00:21:42 +02:00
ocket8888
9db8775ba7 Update example to use recommended usage 2021-06-14 11:21:28 -06:00
Juan Luis Cano Rodríguez
1ffbfa72f1 Merge branch '4.x' into new-tutorial 2021-06-06 10:49:07 +02:00
Takeshi KOMIYA
e0500f7354 doc: Fix docslint misunderstanding scope of code-blocks 2021-06-06 13:24:06 +09:00
Juan Luis Cano Rodríguez
565713d228 Change Pygments lexer to account for prompt 2021-05-31 18:03:04 +02:00
Juan Luis Cano Rodríguez
1da5ab5808 Style fixes 
Co-authored-by: Steve Piercy <web@stevepiercy.com>
 2021-05-31 16:26:21 +02:00
Takeshi KOMIYA
988a79de65 linkcheck: Emit a warning for disallowed redirects 
Now linkcheck builder integrates `linkcheck_warn_redirects` into
`linkcheck_allowed_redirects`.  As a result, linkcheck builder will
emit a warning when "disallowed" redirection detected via
`linkcheck_allowed_redirects`.
 2021-05-31 21:53:09 +09:00
Takeshi KOMIYA
2887dd07df doc: Fix indentation 2021-05-31 02:59:35 +09:00
Takeshi KOMIYA
48c80b17b4 doc: Fix indentation 2021-05-31 02:58:29 +09:00
Takeshi KOMIYA
676834b998 Merge branch '4.x' into 6525_linkcheck_warn_redirects 2021-05-31 02:54:41 +09:00
Takeshi KOMIYA
fe89a07a92 Fix typo in doc/usage/configuration.rst 
Co-authored-by: François Freitag <mail@franek.fr>
 2021-05-31 02:54:17 +09:00
Juan Luis Cano Rodríguez
bfca913f16 Move virtual environment explanation to installation 2021-05-29 19:15:15 +02:00
Grey Li
6a0dae08d0 Fix typo in doc/intl.rst 
The pot files are in the gettext folder instead of locale folder.
 2021-05-27 17:28:10 +08:00