index.rst 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .. blockchain documentation master file, created by
  2. sphinx-quickstart on Mon Mar 6 15:54:51 2017.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. Welcome to blockchain's documentation!
  6. ======================================
  7. This project is a completely new blockchain-based coin, with P2P networking, a consensus mechanism and a wallet interface. The goal of the project is to provide a framework that is easy to modify for people who want to develop proof-of-concepts for blockchain-based technology.
  8. Executables
  9. ***********
  10. .. list-table::
  11. :stub-columns: 1
  12. :widths: 10 90
  13. * - miner
  14. - .. automodule:: miner
  15. * - wallet
  16. - .. automodule:: wallet
  17. Source Code Documentation
  18. *************************
  19. .. autosummary::
  20. :toctree: _autosummary
  21. src.blockchain
  22. src.block
  23. src.chainbuilder
  24. src.crypto
  25. src.merkle
  26. src.mining
  27. src.mining_strategy
  28. src.proof_of_work
  29. src.protocol
  30. src.transaction
  31. src.persistence
  32. src.rpc_client
  33. src.rpc_server
  34. Tests
  35. *****
  36. To run the tests, just run the `pytest` command.
  37. Indices and tables
  38. ==================
  39. * :ref:`genindex`
  40. * :ref:`modindex`
  41. * :ref:`search`