Commit Graph

113 Commits

Author SHA1 Message Date
Takeshi KOMIYA
b9da9237bc Merge branch '3.x' into 6040_autosummary_recursive 2020-04-21 23:04:38 +09:00
Takeshi KOMIYA
476b73b6ca autosummary: Add :recursive: option to autosummary directive 2020-04-21 22:47:00 +09:00
Takeshi KOMIYA
dc46897768 Close #7490: autosummary: Add `:caption:` option to autosummary directive 2020-04-16 23:04:57 +09:00
Takeshi KOMIYA
19d5d8d75c Fix #7477: imgconverter: Invoke "magick convert" command on Windows 2020-04-15 23:23:28 +09:00
PythonCoderAS
c495b2a380
Correct minor typo 2020-03-18 21:49:41 -04:00
Takeshi KOMIYA
d517aa6c16 Close #7079: Make autodoc_typehints=description formal 2020-03-07 13:19:37 +09:00
Takeshi KOMIYA
f13c546862 doc: Update docs 2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
448937eb4d doc: Remove mention about py2 2020-02-24 12:43:00 +09:00
Neal McBurnett
b620a8a6cc
Fix typos
bad quoting, better word usage.
2020-02-09 19:12:52 -07:00
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
woutdenolf
9dc9b8754d Merge with master and address code review 2019-07-08 08:29:23 +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
woutdenolf
ec8656bd27 [autosummary] remove recursion limit and module/package separation 2019-06-02 16:26:40 +02: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