Commit Graph

704 Commits

Author SHA1 Message Date
Takayuki Shimizukawa
c3c879f2c6 use six privided functions/classes to support py2/py3 in one source. refs #1350. 2014-04-29 19:59:58 +09:00
Takayuki Shimizukawa
68290a266c introduce the six module and reduce sphinx.util.pycompat implementation. refs #1350. 2014-04-29 11:46:47 +09:00
Takayuki Shimizukawa
1e4b390b22 remove tests.util.write_file duplicated implementation. 2014-04-28 19:58:26 +09:00
Rob Ruana
bbfd0d058a Closes 1455: Adds better handling of namedtuples in napoleon's skipmember function 2014-04-19 03:58:11 -04:00
Georg Brandl
18755458a1 merge with stable 2014-03-25 09:31:44 +01:00
Takayuki Shimizukawa
43a9881c4b Fix i18n: missing python domain's cross-references with currentmodule directive or currentclass directive. refs #1363
* node attributes 'py:module', 'py:class' is provided from environment (e.x. currentmodule directive is provided on previous line, not on node)
* Because translation nodes are parsed in independently, 'provided attributes by environment' are not exist.
* For a pending_xref nodes, all attributes of a translated xref node should be same as original xref node in current test cases.
* For the above reasons, I overwrite all attributes from origonal node to new translated xref node.
2014-03-23 23:01:15 +09: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
Georg Brandl
f8096e3fa0 merge with stable 2014-03-01 08:42:58 +01:00
Georg Brandl
55e2f29170 fix windows newlines 2014-03-01 08:42:35 +01:00
Georg Brandl
1f4016d679 Merged in barnabas79/sphinx (pull request #218)
Closes #1374: Autosummary generates overly-long summaries if first line doesn't end with a period
2014-03-01 08:28:28 +01:00
Georg Brandl
ac92719ac3 Update copyright year. 2014-03-01 08:18:23 +01:00
Georg Brandl
e030031321 Update copyright year. 2014-03-01 08:18:16 +01:00
Paul Molodowitch
d4a0a14aa5 Closes #1374: Autosummary generates overly-long summaries if first line doesn't end with a period 2014-02-03 19:35:04 -08:00
Paul Molodowitch
05f1049b3e Closes #1374: Autosummary generates overly-long summaries if first line doesn't end with a period 2014-02-03 19:35:04 -08:00
Georg Brandl
b1a9f7548b consistency nits 2014-01-22 18:15:42 +01:00
Dmitry Shachnev
953b33d3f7 Merge 2014-01-22 18:34:51 +04:00
Ben Darnell
3ed243de54 Fix an exception introduced by b69b59480cba for __init__ with no docstring. 2014-01-20 11:54:51 -05:00
Ben Darnell
b0ca105c36 Fix an exception introduced by b69b59480cba for __init__ with no docstring. 2014-01-20 11:54:51 -05:00
Dmitry Shachnev
c2eaf2af81 Merge 2014-01-20 18:32:47 +04:00
Rob Ruana
63fbb819c7 Makes suggested changes before adding napoleon to sphinx 2014-01-19 13:43:54 -05:00
Rob Ruana
4c782604ed Merged birkenfeld/sphinx into default 2014-01-19 12:31:07 -05:00
Georg Brandl
8c2fabe117 The deprecated config values `exclude_trees, exclude_dirnames and unused_docs` have been removed. 2014-01-19 17:46:06 +01:00
Dmitry Shachnev
ce2185ce27 Modernize the code now that Python 2.5 is no longer supported
- Use print function instead of print statement;
- Use new exception handling;
- Use in operator instead of has_key();
- Do not use tuple arguments in functions;
- Other miscellaneous improvements.

This is based on output of `futurize --stage1`, with some
manual corrections.
2014-01-19 14:17:10 +04:00
Georg Brandl
91cd11be3c Merged in guibog/sphinx2 (pull request #184)
autodoc extension: add autodoc_mock_imports config value
2014-01-19 10:31:15 +01: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
Takayuki Shimizukawa
dd41adf0a0 merge heads 2014-01-18 16:34:47 +09:00
Georg Brandl
e5f58d686e merge with stable 2014-01-17 07:25:31 +01:00
Georg Brandl
24a8b516bf Remove sphinx.ext.oldcmarkup compatibility extension. 2014-01-17 07:24:23 +01:00
Georg Brandl
de92e3b026 Closes #1285: Avoid name clashes between C domain objects and section titles. 2014-01-17 07:08:32 +01:00
Takayuki Shimizukawa
cc7509966c merge heads 2014-01-15 05:25:56 +00:00
Georg Brandl
336ae30edb Prompt for the document language in sphinx-quickstart. 2014-01-11 15:05:45 +01:00
Georg Brandl
1d564ace28 merge stable into default 2014-01-11 14:53:07 +01:00
Georg Brandl
c5b4ff0adc * add a test for the parsed-literal directive
* adapt test to pygments output versus Sphinx-emulated nohighlighting output
2014-01-11 10:25:34 +01:00
Georg Brandl
269ef714f3 Closes #668: Allow line numbering of `code-block and literalinclude` directives
#to start at an arbitrary line number, with a new ``lineno-start`` option.
2014-01-11 08:44:45 +01:00
Georg Brandl
5394fbb82b merge stable into default 2014-01-11 08:14:55 +01:00
Georg Brandl
8fdcb803cf d98e70c13eff followup: only do type conversion of confoverrides if the values are strings and add a test 2014-01-10 22:10:29 +01:00
Georg Brandl
195050c6c4 Closes #933: Do not crash if an `:option:` value is malformed (contains spaces
but no option name).
2014-01-10 22:04:03 +01:00
Georg Brandl
865d677eb8 merge stable into default 2014-01-10 21:26:12 +01:00
Georg Brandl
82e294ec0f Closes #1312: use non-deprecated unittest-like names 2014-01-10 15:11:27 +01:00
Georg Brandl
ac48fa83d9 Merged in hsoft/sphinx (pull request #202)
Allow "." and "~" prefixes in inline :param: typedefs.
2014-01-10 14:56:40 +01:00
Virgil Dupras
ea02a07562 Allow "." and "~" prefixes in inline :param: typedefs. 2014-01-04 21:40:52 -05:00
Takayuki Shimizukawa
f7cb510ebd Drop python-3.1 and remove support codes 2013-12-15 16:04:23 +09:00
Takayuki Shimizukawa
a8fc938d1b Drop python-2.5 and remove 2.4,2.5 support codes 2013-12-15 14:16:53 +09:00
Georg Brandl
04bc952dd9 fix trailing space 2013-12-10 10:23:45 +01:00
Takayuki Shimizukawa
1d5c7d1f20 Fix: autodoc class __init__ override not removed from docstring. Closes #1138 2013-12-09 10:55:51 +00:00