mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
2f4da6a32f
* Fix typos pointed out in review by @ttmc * Reword description of an input in the transaction schema * Re-add removed comment in transaction model * Fix small typos in some comments in the transaction model * Add trailling commas to a multiline dict in the transaction model tests * Fix small things with server docs changes * Add description of public keys' association with conditions in transaction concept docs * Reword description of Transaction.create's and args * Rename output_uri to output_condition_uri * Fix hardcoded class name vs. self.__class__ * Rename instances of 'out' with 'output' * Rename instances of and with to avoid name clash with built-in * Remove unnecessary renaming of cryptoconditions.Fulfillment import in transaction model * Remove instances of in transaction model * Remove usages of fulfillment in cases where input makes more sense * Reword docstrings for init methods in transaction models * Rename usages of condition where output is now a better fit * Add descriptions to TransactionLink's txid and idx in schema * Minor correction to output idx description in transaction yaml
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 also use Sphinx to document all REST APIs, with the help of the
httpdomainextension.
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.