mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
89661a9979
moved the transaction version (currently fixed to 1.0) from the outer "transaction" object to the inside part, where it will get hashed together with the rest of the transaction. updated docs accordingly.
The BigchainDB Documentation Strategy
- Include explanatory comments and docstrings in your code. Write Google style docstrings with a maximum line width of 119 characters.
- For quick overview and help documents, feel free to create
README.mdor otherX.mdfiles, written using GitHub-flavored Markdown. Markdown files render nicely on GitHub. We might auto-convert some .md files into a format that can be included in the long-form documentation. - We use Sphinx to generate the long-form documentation in various formats (e.g. HTML, PDF).
- We also use Sphinx to generate Python code documentation (from docstrings and possibly other sources).
- We will use Apiary to document all REST APIs.
How to Generate the HTML Version of the Long-Form Documentation
If you want to generate the HTML version of the long-form documentation on your local machine, you need to have Sphinx and some Sphinx-contrib packages installed. To do that, go to the BigchainDB docs directory (i.e. this directory) and do:
pip install -r requirements.txt
You can then generate the HTML documentation by doing:
make html
The generated HTML documentation will be in the docs/build/html directory. You can view it by opening docs/build/html/index.html in your web browser.