Skip to content

Commit

Permalink
Add failling test cases for sphinx 1.3 autodoc output
Browse files Browse the repository at this point in the history
  • Loading branch information
agjohnson committed Apr 23, 2015
1 parent af82c93 commit e1fd710
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
7 changes: 7 additions & 0 deletions demo_docs/source/api.rst
@@ -0,0 +1,7 @@
:mod:`test_py_module`
=====================

.. automodule:: test_py_module.test
:members:
:private-members:
:special-members:
9 changes: 1 addition & 8 deletions demo_docs/source/index.rst
Expand Up @@ -24,6 +24,7 @@ Contents:
:caption: This is an incredibly long caption for a long menu

long
api

Maaaaath!
=========
Expand Down Expand Up @@ -57,14 +58,6 @@ Giant tables
| body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 | body row 1 | column 2 | column 3 |
+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+------------+------------+-----------+

API Test
========

.. automodule:: test_py_module.test
:members:
:private-members:
:special-members:

Optional parameter args
-----------------------

Expand Down
4 changes: 4 additions & 0 deletions demo_docs/source/test_py_module/test.py
Expand Up @@ -26,6 +26,10 @@ class Foo:
print(myclass)
Here is a link to :py:meth:`capitalize`.
Here is a link to :py:meth:`__init__`.
"""

#: Doc comment for class attribute Foo.bar.
Expand Down

0 comments on commit e1fd710

Please sign in to comment.