Merge pull request #76

53b879f doc: include __init__ docstrings; factor out common flags (Jacob Welsh)
2584abe Update docstrings for RST paragraph flow (Jacob Welsh)
68381f7 Add new modules to sphinx TOC (Jacob Welsh)

Author: petertodd

bitcoin/core/__init__.py

@@ -663,6 +663,7 @@ def CheckBlockHeader(block_header, fCheckPoW = True, cur_time=None):
     """Context independent CBlockHeader checks.
 
     fCheckPoW - Check proof-of-work.
+
     cur_time  - Current time. Defaults to time.time()
 
     Raises CBlockHeaderError if block header is invalid.
@@ -699,7 +700,9 @@ def CheckBlock(block, fCheckPoW = True, fCheckMerkleRoot = True, cur_time=None):
     transaction.
 
     fCheckPoW        - Check proof-of-work.
+
     fCheckMerkleRoot - Check merkle root matches transactions.
+
     cur_time         - Current time. Defaults to time.time()
     """
 

bitcoin/core/key.py

@@ -245,7 +245,9 @@ def set_compressed(self, compressed):
     def recover(self, sigR, sigS, msg, msglen, recid, check):
         """
         Perform ECDSA key recovery (see SEC1 4.1.6) for curves over (mod p)-fields
+
         recid selects which key is recovered
+
         if check is non-zero, additional checks are performed
         """
         i = int(recid / 2)
@@ -349,7 +351,9 @@ class CPubKey(bytes):
     Attributes:
 
     is_valid      - Corresponds to CPubKey.IsValid()
+
     is_fullyvalid - Corresponds to CPubKey.IsFullyValid()
+
     is_compressed - Corresponds to CPubKey.IsCompressed()
     """
 

bitcoin/core/script.py

@@ -741,7 +741,7 @@ def to_p2sh_scriptPubKey(self, checksize=True):
         redeemScript to spend.
 
         checksize - Check if the redeemScript is larger than the 520-byte max
-                    pushdata limit; raise ValueError if limit exceeded.
+        pushdata limit; raise ValueError if limit exceeded.
 
         Since a >520-byte PUSHDATA makes EvalScript() fail, it's not actually
         possible to redeem P2SH outputs with redeem scripts >520 bytes.

bitcoin/core/scripteval.py

@@ -361,6 +361,7 @@ def err_raiser(cls, *args):
             """Helper function for raising EvalScriptError exceptions
 
             cls   - subclass you want to raise
+
             *args - arguments
 
             Fills in the state of execution for you.
@@ -680,9 +681,13 @@ def EvalScript(stack, scriptIn, txTo, inIdx, flags=()):
     """Evaluate a script
 
     stack    - Initial stack
+
     scriptIn - Script
+
     txTo     - Transaction the script is a part of
+
     inIdx    - txin index of the scriptSig
+
     flags    - SCRIPT_VERIFY_* flags to apply
     """
 
@@ -703,8 +708,11 @@ def VerifyScript(scriptSig, scriptPubKey, txTo, inIdx, flags=()):
     """Verify a scriptSig satisfies a scriptPubKey
 
     scriptSig    - Signature
+
     scriptPubKey - PubKey
+
     txTo         - Spending transaction
+
     inIdx        - Index of the transaction input containing scriptSig
 
     Raises a ValidationError subclass if the validation fails.

bitcoin/rpc.py

@@ -306,9 +306,10 @@ def getbalance(self, account='*', minconf=1):
         """Get the balance
 
         account - The selected account. Defaults to "*" for entire wallet. It
-                  may be the default account using "".
+        may be the default account using "".
+
         minconf - Only include transactions confirmed at least this many times.
-                  (default=1)
+        (default=1)
         """
         r = self._call('getbalance', account, minconf)
         return int(r*COIN)
@@ -398,8 +399,8 @@ def getrawtransaction(self, txid, verbose=False):
 
         Raises IndexError if transaction not found.
 
-        verbose - If true a dict is returned instead with additional information
-                 on the transaction.
+        verbose - If true a dict is returned instead with additional
+        information on the transaction.
 
         Note that if all txouts are spent and the transaction index is not
         enabled the transaction may not be available.
@@ -433,8 +434,9 @@ def getreceivedbyaddress(self, addr, minconf=1):
         always show zero.
 
         addr    - The address. (CBitcoinAddress instance)
+
         minconf - Only include transactions confirmed at least this many times.
-                  (default=1)
+        (default=1)
         """
         r = self._call('getreceivedbyaddress', str(addr), minconf)
         return int(r * COIN)

bitcoin/wallet.py

@@ -153,6 +153,7 @@ def from_scriptPubKey(cls, scriptPubKey, accept_non_canonical_pushdata=True, acc
         form.
 
         accept_non_canonical_pushdata - Allow non-canonical pushes (default True)
+
         accept_bare_checksig          - Treat bare-checksig as P2PKH scriptPubKeys (default True)
         """
         if accept_non_canonical_pushdata:
@@ -205,6 +206,7 @@ class CKey(object):
     Attributes:
 
     pub           - The corresponding CPubKey for this private key
+
     is_compressed - True if compressed
 
     """

doc/bitcoin.core.rst

@@ -7,39 +7,24 @@ Everything consensus critical is found in the core subpackage.
 -----------
 
 .. automodule:: bitcoin.core
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`key`
 ----------
 
 .. automodule:: bitcoin.core.key
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`script`
 -------------
 
 .. automodule:: bitcoin.core.script
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`scripteval`
 -----------------
 
 .. automodule:: bitcoin.core.scripteval
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`serialize`
 ----------------
 
 .. automodule:: bitcoin.core.serialize
-    :members:
-    :undoc-members:
-    :show-inheritance:
 

doc/bitcoin.rst

@@ -5,54 +5,43 @@ bitcoin
 --------------
 
 .. automodule:: bitcoin
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`base58`
 -------------
 
 .. automodule:: bitcoin.base58
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`bloom`
 ------------
 
 .. automodule:: bitcoin.bloom
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`messages`
 ---------------
 
 .. automodule:: bitcoin.messages
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`net`
 ----------
 
 .. automodule:: bitcoin.net
-    :members:
-    :undoc-members:
-    :show-inheritance:
 
 :mod:`rpc`
 ----------
 
 .. automodule:: bitcoin.rpc
-    :members:
-    :undoc-members:
-    :show-inheritance:
+
+:mod:`signature`
+----------------
+
+.. automodule:: bitcoin.signature
+
+:mod:`signmessage`
+------------------
+
+.. automodule:: bitcoin.signmessage
 
 :mod:`wallet`
 -------------
 
 .. automodule:: bitcoin.wallet
-    :members:
-    :undoc-members:
-    :show-inheritance:

doc/conf.py

@@ -46,6 +46,15 @@
     'sphinx.ext.viewcode',
 ]
 
+autodoc_default_flags = [
+    'members',
+    'undoc-members',
+    'show-inheritance',
+]
+
+# Include __init__ docstring in class level docs
+autoclass_content = 'both'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']