IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00
Code Issues Packages Projects Releases Wiki Activity
6,753 Commits 11 Branches 236 Tags
36ca4ae393d2f6fc1c3cf3161bca60aa9975f70e
Commit Graph
44 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
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
Rob Ruana 085bfd525d Merge pull request #2126 from dean0x7d/fix_numpy_kwargs 
[Napoleon] Fix NumPy handling of *args and **kwargs parameters
 2015-11-20 19:03:49 -08:00
Rob Ruana 5a388ec0fc [Napoleon] Changes __unicode__ to use the six.u() function 2015-11-18 10:37:00 -08:00
Rob Ruana e926ebb263 Updates #2053 [Napoleon] Updates documentation to indicate napoleon_include_special_with_doc = True by default 2015-11-17 20:13:55 -08:00
Rob Ruana 4061e3244d [Napoleon] Changes __unicode__ to conditionally use the "u" string literal to support Python 3.2 (which is still used by some users) 2015-11-17 17:46:25 -08:00
Rob Ruana 132791c852 Merge pull request #2093 from Sgiath/napoleon-todo 
#2092: Napoleon 'todo' directive
 2015-11-12 14:02:48 -08:00
Rob Ruana f693318c81 Merge pull request #2053 from mhils/patch-1 
Set napoleon_include_special_with_doc to False by default
 2015-11-12 13:52:38 -08: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 27be6614f7 [Napoleon] Miscellaneous formatting fixes to napoleon example docstrings 2015-06-14 13:32:04 -07:00
Rob Ruana d5d6556a8a [Napoleon] Updates docs to use single quoted strings & 4-space indentation 2015-06-11 20:21:37 -07:00
Rob Ruana 92bf7ca36a Merge pull request #1928 from alex/patch-1 
Use an HTTPS url for fonts so these load on HTTPS pages
 2015-06-11 12:52:39 -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 e968a6c1a1 Fix Google Docstring argument regex in Napoleon. Argument type matching is now more permissive 2015-02-15 18:51:29 -05: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 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