mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00

History

libscott 7e33f2bd52 Tx ID as Asset ID (#926 )

* Allow AssetLinks to be used in place of Assets in the Transaction Model and enforce `Transaction.transfer()` to only take an AssetLink

* Remove AssetLink's inheritance from Asset

* Remove id from the Asset model

* Fix get_txids_by_asset_id query for rethinkdb after removing asset's uuid

Because `CREATE` transactions don't have an asset that contains an id
anymore, one way to find all the transactions related to an asset is to
query the database twice: once for the `CREATE` transaction and another
for the `TRANSFER` transactions.

* Add TODO notice for vote test utils to be fixtures

* Update asset model documentation to reflect usage of transaction id

* Fix outdated asset description in transaction schema

2016-12-20 17:28:15 +01:00

root

treat warnings as errors in documentation builds

2016-12-13 14:55:46 +01:00

server

Tx ID as Asset ID (#926 )

2016-12-20 17:28:15 +01:00

README.md

Updated docs/README.md

2016-10-27 14:09:55 +02:00

README.md

Documentation on ReadTheDocs

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.md or other X.md files, 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 also use Sphinx to document all REST APIs, with the help of the httpdomain extension.

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 a subdirectory of docs (e.g. docs/server) and do:

pip install -r requirements.txt

You can then generate the HTML documentation in that subdirectory by doing:

make html

It should tell you where the generated documentation (HTML files) can be found. You can view it in your web browser.