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
15,904 Commits 2 Branches 219 Tags 163 MiB
d8cdad919b
Commit Graph

15904 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
5aa774b97a
Merge pull request #8056 from tk0miya/7780_multi_params_in_numpydoc 
Fix #7780: napoleon: multiple params declaration was wrongly recognized
 2020-08-07 23:58:11 +09:00
Takeshi KOMIYA
16e62c57e9
Merge pull request #8065 from tk0miya/8049_update_testcase 
napoleon: Fix a broken test (refs: #8049)
 2020-08-07 23:54:05 +09:00
Takeshi KOMIYA
a4996f9054 Fix #7780: napoleon: multiple params declaration was wrongly recognized 
So far, napoleon converts multiple paramaters declrarations to single
paramaeter fields (`:param:` and `:type:`) unexpectedly.  As a result,
the output seems broken.

This converts it to multiple parameter fields (a pair of field for each
parameter declration) to build parameter successfully.

Note: The conversion rule is available only when napoleon_use_params=True.
 2020-08-07 23:46:55 +09:00
Takeshi KOMIYA
99e65a59be napoleon: Fix a broken test (refs: #8049) 
Fix a testcase that added just before #8049 merged.
 2020-08-07 23:44:32 +09:00
Takeshi KOMIYA
e188d56ed1 Update CHANGES for PR #8049 2020-08-07 23:40:11 +09:00
Takeshi KOMIYA
62a6df8f3c
Merge pull request #8049 from keewis/type-preprocessing-without-use_param 
enable type preprocessing without use_param
 2020-08-07 23:37:22 +09:00
Keewis
b4dec34ecf update the type hint 2020-08-07 15:41:17 +02:00
Keewis
9d60f3456f return a documenter instance instead of just the class 2020-08-07 15:32:11 +02:00
Takeshi KOMIYA
92a134b419
Merge pull request #8064 from mattdocumatt/3.x 
Add link to third party themes on GitLab
 2020-08-07 22:23:15 +09:00
Matt from Documatt
db9375363c Add link to third party themes on GitLab 
GitLab, alternative to GitHub, also contains a lot of beautiful open source themes.
 2020-08-07 14:46:19 +02:00
Keewis
79a2471032 add a create_documenter method wrapping get_documenter 2020-08-07 14:17:45 +02:00
Keewis
78e4499435 revert the dispatcher changes 2020-08-07 14:10:12 +02:00
Takeshi KOMIYA
e4e9a0f4be Update CHANGES for PR #7799 2020-08-06 11:01:52 +09:00
Takeshi KOMIYA
64a26ff4de
Merge pull request #7799 from keewis/escape-combined-args-kwargs 
Escape combined args kwargs
 2020-08-06 10:59:21 +09:00
Takeshi KOMIYA
9c55630018 Update CHANGES for PR #8048 2020-08-06 10:57:43 +09:00
Takeshi KOMIYA
a8032b4405
Merge pull request #8048 from cjmayo/graphviz 
Don't copy graphviz.css when building man pages
 2020-08-06 10:56:27 +09:00
Chris Mayo
71e9a15ccf Don't copy graphviz.css when building man pages 
_static/graphviz.css is being created alongside the man pages.
 2020-08-05 20:05:49 +01:00
Takeshi KOMIYA
f743be0054
Merge pull request #8047 from cjmayo/typos 
Assorted typos including sphinx-buid in internationalization figure
 2020-08-06 02:38:07 +09:00
Keewis
849d3c18a7 remove the syntax checks from the escape method and update the tests 2020-08-05 19:22:43 +02:00
Takeshi KOMIYA
784e7636d9
Merge pull request #8025 from tk0miya/6698_no-trim-flags 
Close #6698: doctest: Add :trim-flags: and :no-trim-flags: options
 2020-08-06 00:29:36 +09:00
Takeshi KOMIYA
059dc108ba Close #6698: doctest: Add :no-trim-doctest-flags: options 
To control trimming doctest flags manually, this adds new options
:trim-doctest-flags: and :no-trim-doctest-flags: to doctest
directives.  It helps to describes doctest module itself in python
doc (see #6698).
 2020-08-05 23:39:05 +09:00
Keewis
e79cd79cd2 revert the change to DocFieldTransformer 2020-08-05 14:28:32 +02:00
Keewis
478ab44d7e Merge branch '3.x' into escape-combined-args-kwargs 2020-08-04 18:38:03 +02:00
Takeshi KOMIYA
fcf63a20cd
Merge pull request #8021 from keewis/fix-type-preprocessor 
Fix type preprocessor
 2020-08-05 00:19:29 +09:00
Keewis
47da37e1d9 make sure strings are not split using other delimiters 2020-08-04 12:28:30 +02:00
Keewis
fbad78d08f check that a "default <obj>" notation works with xrefs 2020-08-04 12:21:00 +02:00
Keewis
af7d6a5be8 only allow "default <obj>" and "default: <obj>" for now 2020-08-04 12:20:09 +02:00
Keewis
cb61f0f734 document that we don't require use_param = True anymore 2020-08-04 11:39:48 +02:00
Keewis
cac6d1787d preprocess even with napoleon_use_param = False 2020-08-04 10:43:31 +02:00
Chris Mayo
9bac86a2fc Fix typo sphinx-buid in internationalization figure 2020-08-03 19:30:38 +01:00
Chris Mayo
fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
a721631a54
Merge pull request #8043 from tk0miya/refactor_autodoc 
refactor autodoc: Documenter.filter_members()
 2020-08-03 22:34:11 +09:00
Takeshi KOMIYA
281647b657
Merge pull request #8044 from tk0miya/refactor_test_ext_autodoc 
refactor: test: Rename target.enum to target.enums
 2020-08-03 22:33:46 +09:00
Keewis
c4dc1b39d3 Merge branch '3.x' into custom-get_documenter 2020-08-02 22:21:19 +02:00
Takeshi KOMIYA
c0157cf074 refactor: test: Rename target.enum to target.enums 
Using "enum" for module name bothers me on debugging errors because
it sometimes raises ImportError.
 2020-08-03 02:30:30 +09:00
Keewis
2a3f6e4d70 don't try to split along ', ' 2020-08-02 19:28:01 +02:00
Takeshi KOMIYA
59f68baddd refactor: autodoc: Check special-member or not using regexp 2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
46f0b3063d refactor: autodoc: Add EMPTY that matches to no members 
Add a special class `_Empty` to make the comparison of
:exclude-members: option simply.  It never matches to any members.
 2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
a9e0c4b515 refactor: autodoc: ALL matches to any members 
Add a special class `_All` to make the comparison of :*-members: option
simply.  Now it matches to any members.
 2020-08-03 01:58:35 +09:00
Takeshi KOMIYA
57af828882
Merge pull request #8035 from tk0miya/8034_argument_for_private-members 
Close #8034: autodoc: :private-member: can take an list of member names
 2020-08-03 01:57:13 +09:00
Keewis
95897349b9 fix the calls of the custom documenter functions 2020-08-02 15:53:47 +02:00
Keewis
95cb391bcf actually use it as a method 2020-08-02 14:48:14 +02:00
Keewis
7bbcc3e07b Merge branch '3.x' into custom-get_documenter 2020-08-02 14:46:35 +02:00
Keewis
83905c61b0 convert to a method 2020-08-02 14:41:13 +02:00
Keewis
2bdaa6c23e implement the dispatching 2020-08-02 14:05:36 +02:00
Keewis
c212f5842c allow registering custom get_documenter functions 2020-08-02 14:05:09 +02:00
Takeshi KOMIYA
5be006124e
Merge pull request #8033 from tk0miya/8032_typehint_for_ivar_on_parentclass 
Fix #8032: autodoc: A typehint for inherited ivars is not shown
 2020-08-02 19:24:25 +09:00
Takeshi KOMIYA
5d301b44b9 Fix #8032: autodoc: A typehint for inherited ivars is not shown 
This tries to import the parent object for the instance attribute
to get type annotations for the variable.
 2020-08-02 18:27:03 +09:00
Takeshi KOMIYA
cc25bac264
Merge pull request #8031 from tk0miya/8030_annotated_ivar_isnt_shown_with_inherited_members 
Fix #8030: autodoc: An annotated instance variable is not documented
 2020-08-02 18:25:22 +09:00
Takeshi KOMIYA
03a6028663
Merge pull request #8028 from tk0miya/8011_ivar_for_autosummary 
Close #8011: autosummary: Support instance attributes
 2020-08-02 18:24:32 +09:00