Iroha reStructuredTest documentation

The purpose of this documentation is to convey design and architecture aspects of Iroha ledger in a structured approach, as well as operational side: how-tos, guides, and examples. Docs are accessible via ReadTheDocs website, and can be generated to a lot of formats, available in Sphinx. In order to contribute, one should to be familiar with reStructuredTest syntax, and follow principles described in this file.

Principles

• modify only the contents of image_assets and source folders
• if new section/file is added — it should be placed in the list of contents
• if any new principle is added — it should be discussed in GitHub issues first, as an improvement proposal

Setup

Generally, the docs are available via ReadTheDocs website. Although, to check the result locally, you can build them manually, by following this routine:

Prerequisites

• Python 2.7 installed
• pip install -r requirements.txt in docs/source

Build steps

1. cd docs/source
2. make html

After that, the documentation is generated in html format in _build folder. You can check another formats on Sphinx website or just by typing make.

Contributors

The docs are supported by following contributors (emoji key):

Nikolay 📖	誠 🔧