Bitmessage/PyBitmessage-2024-12-03
Archived
2
0
Fork 0
Code Issues 168 Pull Requests 53 Actions Packages Projects Releases 5 Wiki Activity
This repository has been archived on 2024-12-03. You can view files and clone it, but cannot push or open issues or pull requests.
a4c4338190
PyBitmessage-2024-12-03/docs/index.rst

31 lines
400 B
ReStructuredText
Raw Normal View History

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-05-26 14:43:21 +02:00
.. mdinclude:: ../README.md
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
2021-01-31 19:42:34 +01:00
:end-line: 20
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-05-26 14:43:21 +02:00
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
2021-01-31 19:42:34 +01:00
Protocol documentation
----------------------
.. toctree::
:maxdepth: 2
protocol
Add Address doc. Closes: #1727.
2022-07-02 14:31:55 +02:00
address
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
2021-01-31 19:42:34 +01:00
encryption
pow
Code documentation
------------------
Adjusted conf and rst to fix modindex and get informative index
2019-10-09 10:46:47 +02:00
.. toctree::
:maxdepth: 3
autodoc/pybitmessage
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-05-26 14:43:21 +02:00
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
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
2021-01-31 19:42:34 +01:00
.. mdinclude:: ../README.md
:start-line: 21
Reference in New Issue Copy Permalink