PyBitmessage-2024-08-21/docs/index.rst

.. mdinclude:: ../README.md
   :end-line: 20

Protocol documentation
----------------------
.. toctree::
   :maxdepth: 2

   protocol
   encryption
   pow

Code documentation
------------------
.. toctree::
   :maxdepth: 3

   autodoc/pybitmessage


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. mdinclude:: ../README.md
   :start-line: 21
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`
			`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`