Takeshi KOMIYA
938ba386ed
Merge branch '1.7'
2018-02-20 00:02:57 +09:00
Takeshi KOMIYA
f7027049b1
Fix flake8 violations
2018-02-19 23:20:56 +09:00
Patrick Wingo
e505cbb3be
Napoleon: custom section headers ( #4387 )
...
* Changes to allow for custom sections in google/numpy comments when parsing with napoleon
* fixed some formatting to pass flake8 tests
2018-02-15 16:16:23 -05:00
Martin Larralde
4d7c90d857
Implement missing napoleon admonitions
2018-02-13 18:02:02 +01:00
Rob Ruana
eb39f5714a
Merge pull request #4047 from AWhetter/fix_2979_2
...
Properties can have types documented with :type:
2018-02-03 17:42:49 -05:00
Takeshi KOMIYA
2426cedb8b
A happy new year!
2018-01-01 01:06:58 +09:00
Ashley Whetter
8797ff51b3
Properties can have types documented with :type:
2017-09-06 15:57:11 -07:00
Takeshi KOMIYA
8f9dd64992
Merge branch 'stable'
2017-03-26 11:52:15 +09:00
Takeshi KOMIYA
c57e47e042
Year++
2017-03-26 11:49:34 +09:00
Yoshiki Shibukawa
7e178785a7
fix style check warnings
2017-03-03 22:03:16 +09:00
Rob Ruana
f4716ed3a3
[Napoleon] adds xref test data for pull request #3168
2016-12-09 14:13:29 -08:00
Rob Ruana
407a525ac8
[Napoleon] adds xref test data for pull request #3168
2016-11-21 16:12:23 -08:00
shimizukawa
487f3db5f6
To simplify, sphinx uses external mock package even if unittest.mock exists.
2016-10-15 16:22:27 +09:00
Ashley Whetter
cfd4e51802
Python domain can now link container types automatically
...
Google types now greedily match the closing parenthesis.
Also removed name from returns section in Google docstrings.
Instead, everything before the colon is treated as the type.
2016-08-03 17:09:40 +01:00
Rob Ruana
8dde1eb02d
Fix #2541 : [Napoleon] Adds a blank line before parameter descriptions that start with a literal block
2016-06-11 23:55:55 -06:00
Jan Duzinkiewicz
d8cd3ec4be
fix #2379 - Keyword args rendered with type links, as normal parameters (configurable under napoleon_use_keyword option)
2016-03-23 19:30:14 +01:00
Rob Ruana
678f6066f5
Fix #2227 : [Napoleon] Fixes issue in which bulleted lists in parameter descriptions could cause the sphinx builder to fail
2016-01-27 10:16:12 -08:00
Georg Brandl
4f72bdb722
Merge branch 'stable'
2016-01-14 22:54:08 +01:00
Georg Brandl
46d7e8558e
Obligatory copyright update.
2016-01-14 22:54:04 +01:00
Dean Moldovan
ac5c495a53
[Napoleon] Fix NumPy handling of *args and **kwargs parameters
2015-11-21 01:39:59 +01:00
Rob Ruana
6b6d3dbea9
Closes #1840 : [Napoleon] Fixes Google style parsing to only match section headers ending with exactly one colon
2015-07-24 11:31:47 -07:00
Rob Ruana
c48c68eac9
Closes #1840 : [Napoleon] Fixes Google style parsing to only match section headers ending with exactly one colon
2015-07-24 11:30:35 -07:00
Rob Ruana
4670c87be2
Related to #1927 : [Napoleon] always start description on same line as type in Raises section
2015-06-11 12:50:05 -07:00
Rob Ruana
d82d110dfd
Closes #1927 : [Napoleon] fixes parsing & formatting of types in Raises section
2015-06-11 01:16:25 -07:00
Rob Ruana
89d30fca65
Closes #1927 : [Napoleon] fixes parsing & formatting of types in Raises section
2015-06-11 01:15:52 -07:00
Rob Ruana
34add11b5d
Closed #1925 : [Napoleon] provides @property examples & recommends PEP 484 type hints in Napoleon docs
2015-06-09 18:18:22 -07:00
Rob Ruana
048f54f2b0
Closes #1904 : [Napoleon] parses restructuredtext references in fields/params BEFORE splitting on colon
2015-05-27 10:58:26 -07:00
Rob Ruana
eade1e797e
Closes #1904 : [Napoleon] parses restructuredtext references in fields/params BEFORE splitting on colon
2015-05-27 10:57:04 -07:00
Rob Ruana
42f2b30579
Closes #1831 : [Napoleon] Makes google type regex greedy to consume entire type, even if it contains colons
2015-05-03 16:30:40 -07:00
Rob Ruana
568f91d1bf
Closes #1831 : [Napoleon] Makes google type regex greedy to consume entire type, even if it contains colons
2015-05-03 16:28:39 -07:00
Rob Ruana
80eb821ec8
Closes #1831 : [Napoleon] If name is not found in NumPy Doc Returns section, regard the whole line as the type
2015-04-03 21:34:23 -04:00
Rob Ruana
9d2ec40d8b
Closes #1831 : [Napoleon] If name is not found in NumPy Doc Returns section, regard the whole line as the type
2015-04-03 21:32:05 -04:00
Rob Ruana
d51eeab07b
Closes #1716 : Adds "Yield" alias for "Yields" section in napoleon extension
2015-02-09 03:49:31 -05:00
Rob Ruana
c428f9353e
Closes #1484 : add tests to confirm namedtuple subclasses are handled correctly by napoleon extension
2015-02-09 01:28:57 -05:00
Rob Ruana
9df7b53782
Closes #1670 : Fix napoleon handling of *args and **kwargs parameters
2015-01-12 17:08:51 -05:00
Georg Brandl
0071ac8399
Test fixup.
2015-01-09 18:41:09 +01:00
Georg Brandl
a23903d8d5
Merge branch 'stable'
2015-01-03 21:41:14 +01:00
Georg Brandl
d47a7587f9
Complete test suite overhaul.
...
* rename a few test modules to make the names more consistent
* do not copy/use Sphinx from build/ (unnecessary without 2to3)
* use a temporary dir for *all* test projects, the source tree
will stay pristine that way (default is tests/build)
* speed up tests by ~3x by splitting up test projects and avoiding
rebuilds
2014-09-21 17:17:02 +02:00
