blob: dc1e9640f5d95f3c8df9449da1ea1b3b0675fc16 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
.. This is a simple reStructuredText file that represents what I would
.. like the output of transforming my test Python code to be
.. class:: package
=======================
Package trivial_package
=======================
.. class:: module
Module trivial_package.__init__
===============================
.. class:: docstring
A simple docstring.
.. class:: module
Module trivial_package.file1
============================
.. class:: docstring
This is the first example file. It *does* use reStructuredText.
Attributes:
* __docformat__ = "reST" (line 5)
Import: os (line 7)
.. class:: class
Class trivial_package.file1.Fred
--------------------------------
:line: 9
.. class:: docstring
An example class - it announces each instance as it is created.
.. class:: method
Method trivial_package.file1.Fred.__init__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:line: 13
:parameters: self
.. class:: module
Module trivial_package.file2
============================
.. class:: docstring
This module is *not* using reStructuredText for its docstrings.
.. class:: file
File trivial_package.not_python
===============================
(Not a Python module)
.. class:: package
Package trivial_package.sub_package
===================================
.. class:: module
Module trivial_package.sub_package.__init__
-------------------------------------------
(No documentation)
|
