Juan Luis Cano Rodríguez
d505635224
Be more explicit on automatic xref generation
...
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com >
2021-09-06 16:29:43 +02:00
Juan Luis Cano Rodríguez
da93cfc07f
Reword primary domains
2021-09-06 16:26:03 +02:00
Juan Luis Cano Rodríguez
722629b35b
Rephrase explanation on square brackets
2021-09-06 14:58:18 +02:00
Juan Luis Cano Rodríguez
c721d1746a
Style improvement
...
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com >
2021-09-06 14:36:25 +02: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
Nicolas Delon
bf588c42b2
Fix typo in autodoc documentation
2021-08-25 23:42:27 +02:00
Takeshi KOMIYA
d194e0f490
Merge branch '4.x'
2021-08-21 21:03:30 +09: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
8573c281ec
Add section on automatic documentation generation
2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
8334fd983e
Add section on doctests
2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
a5c684510e
Add section on Python code preparation
2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
2c1fa831c1
Add tutorial section on documenting Python objects
2021-08-12 20:06:56 +02:00
Juan Luis Cano Rodríguez
1a1e45f1af
Add cross reference to role definitions
2021-08-12 20:06:56 +02:00
Takeshi KOMIYA
2138c296c6
Merge branch '4.x'
2021-08-13 01:39:42 +09: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
Takeshi KOMIYA
7d7dfd51e1
Merge branch '4.x'
2021-08-11 02:11:01 +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
b9a4a5d06f
Merge branch '4.x'
2021-07-30 02:20:24 +09:00
Darren Ng
8ea5587ed9
:manpage: is a role, not a directive. [ci skip]
2021-07-26 16:33:18 +08:00
Takeshi KOMIYA
6e87c17a76
doc: Add document for autoproperty directive (refs: #9486 )
2021-07-23 23:10:48 +09:00
Takeshi KOMIYA
779274d4b8
Merge branch '4.x'
2021-07-23 02:17:12 +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
4bf43984b2
Merge branch '4.x'
2021-07-20 00:59:12 +09:00
Takeshi KOMIYA
0e5dab0dc1
Merge branch '4.1.x' into 4.x
2021-07-20 00:59:03 +09:00
Takeshi KOMIYA
b799b54c4d
Merge branch '4.x'
2021-07-20 00:45:30 +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
dd00bade70
Merge branch '4.x'
2021-07-12 02:15:45 +09: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
Juan Luis Cano Rodríguez
8531f20eb7
Fix link to NumPy Docstring Standard
2021-07-08 22:34:25 +02: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
