Commit Graph

17 Commits

Author SHA1 Message Date
c9c91b3e7a
Message Encodings section and extended_encoding doc 2022-07-20 17:24:30 +03:00
d88e1301e2
encrypted_payload.rst and encryption.rst docs, crossreferences 2022-07-20 17:24:30 +03:00
2b69288540
Added PoW doc, separate pow_formula.rst and reference in protocol.rst 2022-07-20 17:24:30 +03:00
c0657f61dd
Update docs copyright line 2022-07-20 17:24:30 +03:00
0a493eef82
Started formatting the Protocol Specification:
in index.rst README.md is splitted in two parts - References now in the
bottom of the page; protocol.rst is the separate file, referenced on top.

Closes: #1033
2022-07-20 17:24:30 +03:00
44144f3023
Adjust docs dependencies:
- leave sphinx and sphinx_rtd_theme in the extra and move the rest
   to docs/requirements.txt, which is used by RTD
 - docutils-0.18 caused a build failure
2021-11-23 20:33:02 +02:00
57ca3b1cf0
Update autodoc_mock_imports and apidoc_excluded_paths in docs/conf.py 2021-11-23 20:31:44 +02:00
b5579cf857
Remove stale docs 2021-10-04 16:01:18 +03:00
380530c839
Experimental APIError codes table 2020-09-14 13:11:43 +03:00
lakshyacis
d9ef4a8e8d
fix spelling mistakes 2020-01-04 18:48:23 +05:30
c40c70f807
Marked variables comments in defaults for use in doc.
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:.
2019-11-11 17:13:20 +02:00
4d8d9b169f
Moved ObjectProcessorQueue to queues, added some doc 2019-11-11 12:03:04 +02:00
bug Lady
061a9ef973
fix typos
and flesh out placeholder
2019-11-10 04:07:50 +01:00
7ba296a6fe
Remove "Edit on Github" link: https://github.com/sphinx-doc/sphinx/issues/2386 2019-10-18 01:06:02 +03:00
d412e8341b
Create requirements.txt for readthedocs 2019-10-18 01:06:01 +03:00
9a3a5ec9e8
Adjusted conf and rst to fix modindex and get informative index 2019-10-18 01:06:01 +03:00
coffeedogs
3b75d900f6
Added: Sphinx docs, testing readthedocs integration
* Added: Sphinx configuration including readthedocs config
 * Added: Sphinx fabric task to auto-document the project
 * Fixed: Some issues in the code causing autodoc to fail when parsing
 * Added: Manual docs - structure, proof of concepts and RsT examples
 * Fixed: RsT formatting in docstrings
 * Fixed: Some adjacent minor style and lint issues
2018-06-13 10:07:45 +01:00