Commit Graph

91 Commits

Author SHA1 Message Date
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Georg Brandl
4f4d8688d5 Py3 fix. 2014-11-07 15:19:36 +01:00
Georg Brandl
bbd315b82e merge with stable 2014-11-07 15:03:06 +01:00
Georg Brandl
fa09ec000f Fix :confval:autodoc_docstring_signature not working with signatures
in class docstrings.
2014-11-07 15:01:10 +01:00
Takayuki Shimizukawa
da651089e7 fix trailing space and long line 2014-10-09 23:53:33 +09: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
Georg Brandl
2c396601bf Move env.temp_data content that might be used to resolve references to a new env.ref_context dictionary. 2014-09-20 19:15:41 +02:00
Takayuki Shimizukawa
da20c3713b merge with stable 2014-07-13 11:43:12 +09:00
Takayuki Shimizukawa
b3aa4aa81b * In autodoc, fix display of parameter defaults containing backslashes. Closes #1502 2014-07-02 00:09:11 +09:00
Takayuki Shimizukawa
0fb938ad38 * add test and code comment for pull request #157 2014-06-14 17:03:57 +09:00
Takayuki Shimizukawa
74fbd611ab merge with stable 2014-06-09 22:45:05 +09:00
Takayuki Shimizukawa
1d742bdcf5 * Fix exception on Python3 if nonexistent method is specified by automethod. Closes #1467 2014-06-09 01:43:34 +09:00
Takayuki Shimizukawa
1e58062692 remove 'six' name except importing line. 2014-04-30 21:30:46 +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
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
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
Takayuki Shimizukawa
cc7509966c merge heads 2014-01-15 05:25:56 +00:00
Takayuki Shimizukawa
a8fc938d1b Drop python-2.5 and remove 2.4,2.5 support codes 2013-12-15 14:16:53 +09:00
Takayuki Shimizukawa
1d5c7d1f20 Fix: autodoc class __init__ override not removed from docstring. Closes #1138 2013-12-09 10:55:51 +00:00
Takayuki Shimizukawa
e61f316c74 Fix autodoc with `autoclass_content="both" uses useless object.__init__ docstring when class does not have __init__`. Closes #1337
This caused by a change for #1138.
2014-01-02 12:42:12 +09:00
Georg Brandl
ae8782178e Test suite quickfix. 2013-09-16 09:45:56 +02:00
Georg Brandl
e732807869 Merged in JonnyJD/sphinx/autodoc_novalue (pull request #109)
feature: autodoc: add :annotation: option for autodata and autoattribute
2013-09-16 04:25:53 +02:00
Georg Brandl
56ac8a19ee test suite fixes 2013-04-01 15:11:18 +02:00
Georg Brandl
1af3e3ea71 tests: replace "from util import *" by explicit imports 2013-04-01 11:39:32 +02:00
Georg Brandl
9abf39f912 Fix overlong lines. 2013-03-31 15:44:04 +02:00
Johannes Dewender
649ab8030c autodoc: change :novalue: to :annoation: option
The :novalue: option is now called :annotation: and has an additional feature:
When given with an argument, you can specify what the annotation
of the object will be.
2013-02-27 16:38:55 +01:00
Takayuki Shimizukawa
70f3f889d1 Fix autodoc crash if :members: and :special-members: ware both set (by d7ac5e4). 2013-02-03 22:27:20 +09:00
Takayuki Shimizukawa
e70a43a9c5 Closes #1062: sphinx.ext.autodoc use __init__ method signature for class signature. 2013-02-03 20:27:34 +09:00
Takayuki Shimizukawa
4d4dad3610 test refactoring: use with_setup for all test_autodoc.py's tests 2013-02-03 13:53:10 +09:00
Takayuki Shimizukawa
e47f434c32 add test for pull request #111: Respect add_autodoc_attrgetter() even when inherited-members is set 2013-02-03 12:48:39 +09:00
Johannes Dewender
ffb825d733 fix tests for autodoc novalue option
In the tests for autodoc the Options are of type struct,
while in the code there is a special autodoc.Options class,
which is a dict.

So "novalue" in self.options doesn't work,
but self.options.novalue does work for both.

Additionally the logic for autoattribute was wrong and is fixed now.
2013-01-24 18:17:53 +01:00
Takayuki Shimizukawa
3a5277c14c fix: autodoc documented descriptor class as attribute 2013-01-12 18:12:55 +09:00
Jonathan Waltman
bba6104b84 Issue #1069: Add failing test for signature formatting of "partial" functions without kwargs. 2013-01-09 08:37:53 -06:00
Jonathan Waltman
42c90ee178 Add basic debugging support for autodoc. 2013-01-05 08:28:54 -06:00
Georg Brandl
151856819c Copyright update. 2013-01-01 22:13:15 +01:00
Jonathan Waltman
6f9e541ab5 autodoc: Handle explicit instance attributes in :members: (re #904) 2012-11-08 21:19:47 -06:00
Jonathan Waltman
bf362e9ccb Closes #617: Fix docstring preparation without included signature: only ignore indentation of one line, not two. 2012-09-16 01:08:47 -05:00
Georg Brandl
a63230f12d #431: Doc comments for attributes can now be given on the same line as the assignment. 2011-01-15 15:40:59 +01:00
Georg Brandl
dc0c43da9a #437: autodoc now shows values of class data attributes. 2011-01-08 23:45:58 +01:00
Łukasz Langa
48d64cc4cb Support for autodocumenting partial functions. 2011-01-08 18:06:24 +01:00
Georg Brandl
5c39cfb6e9 merge with 1.0 2011-01-07 19:04:53 +01:00
Georg Brandl
b44e894125 Fix test_autodoc. 2011-01-07 19:03:44 +01:00
Georg Brandl
0d1a8e5720 merge with 1.0 2011-01-06 13:07:07 +01:00
Georg Brandl
8621526045 #568: Fix lookup of class attribute documentation on descriptors so that comment documentation now works.
Needed to port assignment of ``self.parent`` from trunk.
2011-01-06 13:03:17 +01:00
Georg Brandl
17efae5622 merge with 1.0 2011-01-04 11:29:09 +01:00
Georg Brandl
0e1db6ad90 New year update. 2011-01-04 10:00:51 +01:00
Georg Brandl
8fd5bd1e19 Fix docstring preparation with included signature: ignore indentation of two lines when looking for the signature. 2011-01-04 00:04:04 +01:00