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
16,073 Commits 2 Branches 219 Tags
a843fd3db8b588be93b576049a8a291bc4b3ec9d
Commit Graph

3412 Commits

Author SHA1 Message Date
Takeshi KOMIYA
bb0b69544b Fix #7756: py domain: The default value for posonlyarg is not shown 2020-05-31 12:21:55 +09:00
Takeshi KOMIYA
c1fd36cc9c Close #4422: autodoc: Support GenericAlias 2020-05-30 21:53:42 +09:00
Takeshi KOMIYA
e20f29e325 Add sphinx.util.inspect:isgenericalias() 2020-05-30 21:06:54 +09:00
Takeshi KOMIYA
800dcf0f0a Close #2106: autodoc: Support multiple signatures on docstring 2020-05-30 15:40:21 +09:00
Takeshi KOMIYA
928149b730 Merge pull request #7746 from rsokl/patch-1 
Fix bug in mathjax: newest 2.x version not being loaded by latest.js
 2020-05-30 13:14:07 +09:00
Takeshi KOMIYA
03559f0574 Merge pull request #7738 from tk0miya/7734_napoleon_overescaped_underscore 
Fix #7734: napoleon: overescaped trailing underscore on attribute
 2020-05-30 01:21:45 +09:00
Ryan Soklaski
1d332a2e0a Update test_ext_math.py 
Bump hardcoded mathjax version to 2.7.7
 2020-05-28 23:15:39 -04:00
Eric Wieser
d229b120ad Fix autoclass signature parsing 
This fixes:
* Signatures defined by __new__
* Signatures defined by metaclasses
* Signatures defined by builtin base classes

All of these changes bring the sphinx docs inline with the behavior of `inspect.signature`.

Note that this changes autodoc to output `.. py:class: MyClass()` with parentheses even if no user-defined __init__ is present.
This is quite deliberate, as if no user-defined `__init__` is present the default is `object.__init__`, which indeed does not take arguments.
 2020-05-28 08:36:56 +01:00
Takeshi KOMIYA
ee4c7d3a68 Merge pull request #7713 from tk0miya/3673_autodoc_sort_by_all 
Fix #3673: autodoc: bysource order does not work for a module having __all__
 2020-05-28 01:50:24 +09:00
Takeshi KOMIYA
a28c9ad842 Fix #7734: napoleon: overescaped trailing underscore on attribute 2020-05-28 01:47:33 +09:00
Takeshi KOMIYA
36fd5bfa9a refactor test_project: PathComparer is unnecessary for this case 2020-05-27 02:44:53 +09:00
Takeshi KOMIYA
a5e3b4a43d Fix #3673: autodoc: bysource order does not work for a module having __all__ 2020-05-23 21:52:11 +09:00
Takeshi KOMIYA
a1293e2825 Merge pull request #7709 from tk0miya/refactor_test_ext_autodoc 
refactor: test: Separate tests for autofunction
 2020-05-23 02:38:53 +09:00
Takeshi KOMIYA
6a4148abec Merge pull request #7669 from tk0miya/7668_wront_retann 
Fix #7668: autodoc: wrong retann value is passed to autodoc-proccess-signature
 2020-05-23 00:43:18 +09:00
Takeshi KOMIYA
f13e05a01b refactor: test: Separate tests for autofunction 2020-05-22 23:41:45 +09:00
Jakob Lykke Andersen
589df567c0 Merge pull request #7708 from jakobandersen/c_cpp_fix_test_typo 
C, C++: fix typo in tests
 2020-05-22 16:25:57 +02:00
Takeshi KOMIYA
c5f7ded772 Merge branch '3.x' into 7668_wront_retann 2020-05-22 23:15:47 +09:00
Takeshi KOMIYA
c1ef87a23b Fix #7696: html: Updated jQuery version from 3.4.1 to 3.5.1 2020-05-22 23:12:31 +09:00
Takeshi KOMIYA
3893620cb4 Merge pull request #7705 from tk0miya/7696_jquery-3.5.1 
Fix #7696: html: Updated jQuery version from 3.4.1 to 3.5.1
 2020-05-22 23:11:44 +09:00
Jakob Lykke Andersen
07c74b5ff4 C, C++: fix typo in tests 2020-05-22 15:39:47 +02:00
Takeshi KOMIYA
eb29926441 Fix #7696: html: Updated jQuery version from 3.4.1 to 3.5.1 2020-05-22 00:59:17 +09:00
Takeshi KOMIYA
784d4cb36a Fix #7685: autosummary: imported members are listed unexpectedly 2020-05-21 01:24:46 +09:00
Daniel Fremont
de4aca857c revisions per comments from tk0miya 2020-05-17 09:07:11 -07:00
Takeshi KOMIYA
3206e3154a Add allowed_exceptions parameter to Sphinx.emit() (refs: #7683) 
It allows handlers to raise specified exceptions.
 2020-05-17 19:18:10 +09:00
Takeshi KOMIYA
3c7d35d2a2 Merge branch '3.x' 2020-05-17 19:12:56 +09:00
Takeshi KOMIYA
38a21d7dac Fix #7676: autodoc: typo in the default value of autodoc_member_order 2020-05-17 01:47:32 +09:00
Jakob Lykke Andersen
3b3dfab915 Merge pull request #7678 from jakobandersen/c_anon_test 
C, enable tests of anon entities
 2020-05-16 17:07:30 +02:00
Jakob Lykke Andersen
4dad6d6262 C, enable tests of anon entities 2020-05-16 16:56:53 +02:00
Takeshi KOMIYA
99f0479855 Merge pull request #7677 from tk0miya/refactor_singledispatch 
refactor: autodoc: Remove magic mock from singledispatch processing
 2020-05-16 23:05:13 +09:00
Takeshi KOMIYA
fcfdc19624 refactor: autodoc: Remove magic mock from singledispatch processing 2020-05-16 22:55:24 +09:00
Jakob Lykke Andersen
2c90418107 C, fix rendering of rooted nested names 
Also, test doctree generation via astext().
 2020-05-16 12:40:20 +02:00
Jakob Lykke Andersen
404557c516 C++, fix rendering of rooted nested names 
Also, test doctree generation via astext().
 2020-05-16 11:55:36 +02:00
Takeshi KOMIYA
b8ecec83d4 Merge pull request #7661 from mondeja/7552 
Fix autosummary directive wrong processing for invalid modules.
 2020-05-16 17:56:03 +09:00
Jakob Lykke Andersen
97accc931d Merge pull request #7663 from jakobandersen/astext 
Fix astext() for two Sphinx nodes
 2020-05-16 10:09:22 +02:00
Takeshi KOMIYA
0526e0a56c Merge branch '3.x' into 7650_undecorated_signature 2020-05-16 14:56:54 +09:00
Takeshi KOMIYA
dff45a11b7 Fix #7668: autodoc: wrong retann value is passed to autodoc-proccess-signature 2020-05-16 14:51:18 +09:00
Jakob Lykke Andersen
41971382f8 ... and don't break tests. 2020-05-14 19:41:17 +02:00
Álvaro Mondéjar
02d5cd439f Update 'test_autosummary_generate' test. 2020-05-14 19:16:45 +02:00
Álvaro Mondéjar
1dcfc44ace Fix automsummary directive wrong processing for invalid modules. 2020-05-14 17:06:12 +02:00
John R. Lenton
61378fe048 Make sphinx.util.typing.stringify render optional unions better 
Without this change, stringify(Optional[Union[int, str]]) returns
'Union[int, str, None]' rather than the expected 'Optional[...]'.

This change fixes that.

fixes: #7654
 2020-05-11 17:20:45 +01:00
Takeshi KOMIYA
3a81ffa79a Fix #7650: autodoc: undecorated signature is shown for decorated functions 2020-05-11 01:11:12 +09:00
Takeshi KOMIYA
caddd3a547 Fix test_ext_autodoc: Set testroot to testcases 2020-05-11 00:37:36 +09:00
Kjell Braden
db72c18cf9 add testcase for complex typehintsext.autodoc.typehints 2020-05-10 20:46:29 +09:00
Takeshi KOMIYA
29829bd451 Merge pull request #7623 from tk0miya/7362_autofunction_for_builtins 
Fix #7362: autodoc: does not render correct signatures for built-in functions
 2020-05-09 18:46:13 +09:00
Takeshi KOMIYA
26f620253d Merge branch '3.0.x' into 3.x 2020-05-09 18:40:47 +09:00
Takeshi KOMIYA
6c65327be7 Merge pull request #7624 from tk0miya/refactor_autodoc2 
refactor: autodoc: class processors on autofunction is no longer needed
 2020-05-09 18:10:55 +09:00
Takeshi KOMIYA
92e0007179 Fix autodoc: does not render correct signatures for built-in methods 2020-05-09 17:38:28 +09:00
Takeshi KOMIYA
815abf0fea Fix #7362: autodoc: does not render correct signatures for built-in functions 2020-05-09 16:37:03 +09:00
Takeshi KOMIYA
e49fc778e4 Merge pull request #7632 from eric-wieser/better-inspect-failure 
Do not crash if `is_builtin_class_method` is passed a non-type
 2020-05-09 14:56:40 +09:00
Eric Wieser
c8a4c79daf Do not crash if is_builtin_class_method is passed a non-type 2020-05-08 08:54:53 +01:00