cis-kuldeep/PyBitmessage-2021-04-27
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Marked variables comments in defaults for use in doc.

Browse Source 
Allowed autodoc in bitmessagemain, class_objectProcessor, defaults:
seems safe now.

Changed docs conf: don't sort module members, treat any string
inside backticks as :obj:.
This commit is contained in:
Dmitri Bogomolov 2019-11-04 14:29:57 +02:00
parent d6c1845b71
commit c40c70f807
Signed by untrusted user: g1itch
GPG Key ID: 720A756F18DEED13
2 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/conf.py
View File

@ -49,6 +49,8 @@ extensions = [
'm2r', 'm2r',
] ]
default_role = 'obj'
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -199,7 +201,6 @@ epub_exclude_files = ['search.html']
autodoc_mock_imports = [ autodoc_mock_imports = [
'debug', 'debug',
'pybitmessage.bitmessagekivy', 'pybitmessage.bitmessagekivy',
'pybitmessage.bitmessagemain',
'pybitmessage.bitmessageqt.addressvalidator', 'pybitmessage.bitmessageqt.addressvalidator',
'pybitmessage.helper_startup', 'pybitmessage.helper_startup',
'pybitmessage.network.httpd', 'pybitmessage.network.httpd',
@ -219,15 +220,15 @@ autodoc_mock_imports = [
'qrcode', 'qrcode',
'stem', 'stem',
] ]
autodoc_member_order = 'bysource'
# Apidoc settings # Apidoc settings
apidoc_module_dir = '../pybitmessage' apidoc_module_dir = '../pybitmessage'
apidoc_output_dir = 'autodoc' apidoc_output_dir = 'autodoc'
apidoc_excluded_paths = [ apidoc_excluded_paths = [
'bitmessagekivy', 'bitmessagemain.py', 'build_osx.py', 'bitmessagekivy', 'build_osx.py',
'bitmessageqt/addressvalidator.py', 'bitmessageqt/migrationwizard.py', 'bitmessageqt/addressvalidator.py', 'bitmessageqt/migrationwizard.py',
'bitmessageqt/newaddresswizard.py', 'bitmessageqt/newaddresswizard.py', 'helper_startup.py',
'class_objectProcessor.py', 'defaults.py', 'helper_startup.py',
'kivymd', 'main.py', 'navigationdrawer', 'network/http*', 'kivymd', 'main.py', 'navigationdrawer', 'network/http*',
'pybitmessage', 'tests', 'version.py' 'pybitmessage', 'tests', 'version.py'
] ]

22
src/defaults.py
View File

@ -1,24 +1,24 @@
""" """
src/defaults.py Common default values
===============
""" """
# sanity check, prevent doing ridiculous PoW #: sanity check, prevent doing ridiculous PoW
# 20 million PoWs equals approximately 2 days on dev's dual R9 290 #: 20 million PoWs equals approximately 2 days on dev's dual R9 290
ridiculousDifficulty = 20000000 ridiculousDifficulty = 20000000
# Remember here the RPC port read from namecoin.conf so we can restore to #: Remember here the RPC port read from namecoin.conf so we can restore to
# it as default whenever the user changes the "method" selection for #: it as default whenever the user changes the "method" selection for
# namecoin integration to "namecoind". #: namecoin integration to "namecoind".
namecoinDefaultRpcPort = "8336" namecoinDefaultRpcPort = "8336"
# If changed, these values will cause particularly unexpected behavior: # If changed, these values will cause particularly unexpected behavior:
# You won't be able to either send or receive messages because the proof # You won't be able to either send or receive messages because the proof
# of work you do (or demand) won't match that done or demanded by others. # of work you do (or demand) won't match that done or demanded by others.
# Don't change them! # Don't change them!
# The amount of work that should be performed (and demanded) per byte of the payload. #: The amount of work that should be performed (and demanded) per byte
#: of the payload.
networkDefaultProofOfWorkNonceTrialsPerByte = 1000 networkDefaultProofOfWorkNonceTrialsPerByte = 1000
# To make sending short messages a little more difficult, this value is #: To make sending short messages a little more difficult, this value is
# added to the payload length for use in calculating the proof of work #: added to the payload length for use in calculating the proof of work
# target. #: target.
networkDefaultPayloadLengthExtraBytes = 1000 networkDefaultPayloadLengthExtraBytes = 1000