Commit Graph
19 Commits
Author SHA1 Message Date
Rob Ruana 8e780a5a10 Merge pull request #1706 from psav/usage_section
Added Usage section to be compatible with Cartouche
2015-02-04 08:32:51 -05:00
Rob Ruana 53aa275bd3 Update my info in AUTHORS from @RelentlessIdiot to @RobRuana 2015-02-02 05:20:24 -05:00
Rob Ruana 9df7b53782 Closes #1670: Fix napoleon handling of *args and **kwargs parameters 2015-01-12 17:08:51 -05:00
Rob Ruana 71b8fe8854 Closes #1489: Removes use of ":annotation:" for attribute types in napoleon, as inline markup is not allowed 2014-06-13 14:06:39 -06:00
Rob Ruana 7f710be021 Updates Napoleon documentation per suggestion by a user 2014-04-26 19:43:46 -04:00
Rob Ruana bbfd0d058a Closes 1455: Adds better handling of namedtuples in napoleon's skipmember function 2014-04-19 03:58:11 -04:00
Rob Ruana c430f7f4c6 Closes #1429: Adds smarter Args parsing for Google style docstrings. 2014-03-21 19:21:18 -04:00
Rob Ruana 3e7ce5d3a1 Closes #1418: Private and special members are properly skipped on Python 3.3 2014-03-11 03:50:49 -04:00
Rob Ruana 191e0b4c12 Closes #1384: Parse and interpret See Also section the way NumpyDoc does
The NumpyDoc extension that is developed by the Numpy folks does a lot
of extra work interpreting See Also sections. It assumes that the contents
of the See Also will always be references to other functions/classes and
it tries to deduce what is being referenced.

I've ported their implementation for See Also sections written in the
Numpy style. There is NO extra interpretation done for See Also sections
that are written using the Google style.
2014-03-09 22:07:21 -04:00
Rob Ruana 18df6421bf Closes #1396: Param types with inline markup no longer italicized
Napoleon was attempting to render nested inline markup
( [a big no-no!](http://sphinx-doc.org/rest.html) ) for
parameter types. Now, if Napoleon sees any backquotes
in the parameter type, it is rendered without italics.
2014-03-09 01:56:56 -05:00
Rob Ruana 5564012306 Closes #1410: imports Mock from unittest.mock when available (Python >=3.3) 2014-03-06 03:49:11 -05:00
Rob Ruana fcb39a75c7 Closes #1413: Moves SearchEnglish import below SearchLanguage definition 2014-03-06 01:56:22 -05:00
Rob Ruana 4219cd32c8 Merging changes 2014-01-19 13:44:28 -05:00
Rob Ruana 63fbb819c7 Makes suggested changes before adding napoleon to sphinx 2014-01-19 13:43:54 -05:00
Rob Ruana 3dcf8f4119 Merged birkenfeld/sphinx into default 2014-01-19 13:40:06 -05:00
Rob Ruana 4c782604ed Merged birkenfeld/sphinx into default 2014-01-19 12:31:07 -05:00
Rob Ruana d11cb7325e Merge conflicts 2014-01-18 14:23:23 -05:00
Rob Ruana a00a096069 Merges napoleon extension into mainline sphinx 2014-01-18 13:56:23 -05:00
Rob Ruana 718f4a6f8c Fix #1203: Does not append space to unknown field names.
If an unknown field name is encountered, a space is only
appended if the field arguments are not empty. Also,
only the first character of the field name is upper cased,
and the case of the rest of the string remains unchanged.
2013-06-23 16:06:45 -04:00