Commit Graph

75 Commits

Author SHA1 Message Date
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