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

37 lines
468 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 12:43:21 +00: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 18:42:34 +00:00
:end-line: 20
Try using toctree one more time
2021-01-31 20:17:51 +00:00
Protocol documentation
----------------------
.. toctree::
:maxdepth: 2
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 18:42:34 +00:00
Try using toctree one more time
2021-01-31 20:17:51 +00:00
protocol
encryption
pow
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 12:43:21 +00:00
Try using toctree one more time
2021-01-31 20:17:51 +00:00
Code documentation
------------------
Adjusted conf and rst to fix modindex and get informative index
2019-10-09 08:46:47 +00:00
.. toctree::
:maxdepth: 3
autodoc/pybitmessage
Legacy pages
------------
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 12:43:21 +00:00
.. toctree::
:maxdepth: 2
usage
contribute
Adjusted conf and rst to fix modindex and get informative index
2019-10-09 08:46:47 +00:00
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 12:43:21 +00: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 18:42:34 +00:00
.. mdinclude:: ../README.md
:start-line: 21