Neal McBurnett
9b125cf8e9
Clarify documentation on use of doctest extension
...
When I first read this section, I was mightily confused due to lack of context and the use of the passive voice.
I think this phrasing clarifies the context and indicates more clearly what the documentation author does
vs what the doctest extension and builder do.
But I'm a newbie here, so please ensure that I got this right....
2020-02-09 16:59:39 -07:00
Takeshi KOMIYA
e7a0af807a
Merge branch '2.0'
2020-01-30 23:29:32 +09:00
Takeshi KOMIYA
5397664d42
Add a new extension: sphinx.ext.autodoc.typehints
2020-01-25 17:56:39 +09:00
Takeshi KOMIYA
347e301727
Merge branch '2.0'
2020-01-19 22:47:02 +09:00
Takeshi KOMIYA
74a5f350a1
Add new event: autodoc-before-process-signature
2020-01-13 13:16:59 +09:00
Takeshi KOMIYA
b968bb91e9
Close #6830 : autodoc: consider a member private if docstring has "private" metadata
2020-01-04 13:28:07 +09:00
Takeshi KOMIYA
0319faf8f1
Merge branch '2.0'
2020-01-01 14:40:39 +09:00
Takeshi KOMIYA
2f36d792f3
Update CHANGES for PR #5230
2020-01-01 12:59:20 +09:00
Takeshi KOMIYA
e628afd5cd
Merge branch '2.0'
2020-01-01 11:39:46 +09:00
Takeshi KOMIYA
18e25d680d
Close #6966 : graphviz: Support `:class:` option
2019-12-27 22:38:10 +09:00
Takeshi KOMIYA
1fc4e8c251
Merge branch '2.0'
2019-12-25 22:44:12 +09:00
Takeshi KOMIYA
de9ee3e70a
doc: Fix sphinx.ext.duration will be added since 2.4.0
2019-12-25 22:43:56 +09:00
Takeshi KOMIYA
e83bb29789
Merge pull request #6873 from tk0miya/5923_autodoc_inherited_members_can_ignore_specific_superclass
...
Close #5923 : autodoc: allow not to document inherited members of specific super class
2019-12-22 16:30:56 +09:00
Takeshi KOMIYA
a209002b81
doc: Add examples for :inherited-members:
2019-12-22 16:05:45 +09:00
Takeshi KOMIYA
d47f38e22d
Merge branch '2.0'
2019-12-21 12:21:49 +09:00
Takeshi KOMIYA
29687a29f1
Close #6446 : Add sphinx.ext.durations to inspect durations of build
2019-12-16 00:47:23 +09:00
Takeshi KOMIYA
fb9adbf0be
Merge pull request #6870 from stsewd/update-docs-intersphinx-with-basic-auth
...
Update docs about intersphinx and basic auth support
2019-12-03 01:42:37 +09:00
Santos Gallegos
46c68302be
Be more specific about the type of login
2019-12-02 11:07:17 -05:00
Takeshi KOMIYA
7c79a6b8d1
Close #5923 : autodoc: allow not to document inherited members of specific super class
2019-12-01 12:51:28 +09:00
Takeshi KOMIYA
15c266c445
Merge branch '2.0'
2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
82a6048f12
Fix typo
2019-11-28 23:31:08 +09:00
Santos Gallegos
f7c1e9190a
Linter
2019-11-27 15:38:26 -05:00
Santos Gallegos
a72d8f6808
Update docs about intersphinx and basic auth support
...
This was added in #2089 but the docs don't mention it.
2019-11-27 15:23:52 -05:00
Takeshi KOMIYA
82b2b1752a
doc: URL of numpydoc has changed
2019-11-27 00:12:32 +09:00
Takeshi KOMIYA
66c3dd3adb
Close #6798 : autosummary: emit `autodoc-skip-member` event on generating stub file
2019-11-16 18:19:31 +09:00
Takeshi KOMIYA
01f8dad160
Merge branch '2.0'
2019-08-19 00:37:30 +09:00
jfbu
4ae5414ee5
Update our docs for imgmath_latex (refs: #6610 )
2019-08-03 12:00:24 +02:00
jfbu
47cd262b3e
Merge branch '2.0'
2019-08-01 18:30:48 +02:00
jfbu
7c59e44eaa
Fix version changed info in our document for imgmath
2019-08-01 18:24:28 +02:00
jfbu
da3763170e
Reorganize documentation of the imgmath configuration variables
2019-08-01 17:52:28 +02:00
jfbu
505ff622c2
More robust code for getting saved "depth" of svg inline math snippet
2019-08-01 17:52:28 +02:00
jfbu
1adf12bfa7
Make imgmath_use_preview work also for svg output
2019-08-01 17:52:28 +02:00
Takeshi KOMIYA
4af90fcf75
Fix #247 : autosummary: Add autosummary_generate_option to overwrite old stub file
2019-07-07 16:18:49 +09:00
Takeshi KOMIYA
c18dcf08f9
Merge branch '2.0'
2019-06-30 01:08:48 +09:00
Takeshi KOMIYA
828beb12e0
doc: Update document for :annotation: option (refs: #6495 )
2019-06-29 18:43:30 +09:00
Takeshi KOMIYA
5d42659e33
Merge branch '2.0'
2019-06-15 23:39:44 +09:00
Takeshi KOMIYA
ce2f9c2b94
Close #5124 : graphviz: :graphviz_dot: option is renamed to :layout:
2019-06-02 21:33:34 +09:00
Takeshi KOMIYA
c4f44bdd22
Merge branch '2.0'
2019-06-02 21:17:38 +09:00
Takeshi KOMIYA
1303ea7cdf
docs: Use directive:option in extensions/graphviz
2019-06-02 18:18:55 +09:00
Takeshi KOMIYA
91fceb4b5f
Merge branch '2.0.2' into 2.0
2019-06-02 00:58:46 +09:00
Takeshi KOMIYA
ce3c5735cd
Merge branch '2.0'
2019-06-01 01:45:47 +09:00
Takeshi KOMIYA
2afba22cee
Merge pull request #6397 from tk0miya/6361_autodoc_typehints
...
Close #6361 : autodoc: Add autodoc_typehints to suppress typehints from signature
2019-06-01 01:07:37 +09:00
Takeshi KOMIYA
d6063ff35b
doc: Fold lines by 80 columns
2019-05-30 01:07:05 +09:00
Takeshi KOMIYA
b9d7239d90
Merge branch '2.0'
2019-05-29 00:51:25 +09:00
Takeshi KOMIYA
9b2423c5bb
doclinter: restrict by 90 columns
2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
0ea380eddd
Close #6361 : autodoc: Add autodoc_typehints to suppress typehints from signature
2019-05-26 00:35:24 +09:00
Adrián Chaves
e84ba7f78a
Support coverage_ignore_pyobjects in the coverage builder
2019-05-15 12:23:05 +02:00
jfbu
48ad83d061
Reorganize documentation of the imgmath configuration variables
2019-04-24 12:30:18 +02:00
jfbu
ea28bd9fb0
More robust code for getting saved "depth" of svg inline math snippet
2019-04-24 11:56:19 +02:00
jfbu
3edcff7952
Make imgmath_use_preview work also for svg output
2019-04-23 15:13:21 +02:00
