Skip to content

Commit 53b879f

Browse files
committed
doc: include __init__ docstrings; factor out common flags
1 parent 2584abe commit 53b879f

File tree

3 files changed

+9
-42
lines changed

3 files changed

+9
-42
lines changed

doc/bitcoin.core.rst

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,24 @@ Everything consensus critical is found in the core subpackage.
77
-----------
88

99
.. automodule:: bitcoin.core
10-
:members:
11-
:undoc-members:
12-
:show-inheritance:
1310

1411
:mod:`key`
1512
----------
1613

1714
.. automodule:: bitcoin.core.key
18-
:members:
19-
:undoc-members:
20-
:show-inheritance:
2115

2216
:mod:`script`
2317
-------------
2418

2519
.. automodule:: bitcoin.core.script
26-
:members:
27-
:undoc-members:
28-
:show-inheritance:
2920

3021
:mod:`scripteval`
3122
-----------------
3223

3324
.. automodule:: bitcoin.core.scripteval
34-
:members:
35-
:undoc-members:
36-
:show-inheritance:
3725

3826
:mod:`serialize`
3927
----------------
4028

4129
.. automodule:: bitcoin.core.serialize
42-
:members:
43-
:undoc-members:
44-
:show-inheritance:
4530

doc/bitcoin.rst

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,70 +5,43 @@ bitcoin
55
--------------
66

77
.. automodule:: bitcoin
8-
:members:
9-
:undoc-members:
10-
:show-inheritance:
118

129
:mod:`base58`
1310
-------------
1411

1512
.. automodule:: bitcoin.base58
16-
:members:
17-
:undoc-members:
18-
:show-inheritance:
1913

2014
:mod:`bloom`
2115
------------
2216

2317
.. automodule:: bitcoin.bloom
24-
:members:
25-
:undoc-members:
26-
:show-inheritance:
2718

2819
:mod:`messages`
2920
---------------
3021

3122
.. automodule:: bitcoin.messages
32-
:members:
33-
:undoc-members:
34-
:show-inheritance:
3523

3624
:mod:`net`
3725
----------
3826

3927
.. automodule:: bitcoin.net
40-
:members:
41-
:undoc-members:
42-
:show-inheritance:
4328

4429
:mod:`rpc`
4530
----------
4631

4732
.. automodule:: bitcoin.rpc
48-
:members:
49-
:undoc-members:
50-
:show-inheritance:
5133

5234
:mod:`signature`
5335
----------------
5436

5537
.. automodule:: bitcoin.signature
56-
:members:
57-
:undoc-members:
58-
:show-inheritance:
5938

6039
:mod:`signmessage`
6140
------------------
6241

6342
.. automodule:: bitcoin.signmessage
64-
:members:
65-
:undoc-members:
66-
:show-inheritance:
6743

6844
:mod:`wallet`
6945
-------------
7046

7147
.. automodule:: bitcoin.wallet
72-
:members:
73-
:undoc-members:
74-
:show-inheritance:

doc/conf.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,15 @@
4646
'sphinx.ext.viewcode',
4747
]
4848

49+
autodoc_default_flags = [
50+
'members',
51+
'undoc-members',
52+
'show-inheritance',
53+
]
54+
55+
# Include __init__ docstring in class level docs
56+
autoclass_content = 'both'
57+
4958
# Add any paths that contain templates here, relative to this directory.
5059
templates_path = ['_templates']
5160

0 commit comments

Comments
 (0)