1
0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-06-16 01:23:22 +02:00
bigchaindb/docs
2016-02-09 19:16:18 +01:00
..
build moved documentation to new repo 2016-02-09 19:16:18 +01:00
source moved documentation to new repo 2016-02-09 19:16:18 +01:00
make.bat moved documentation to new repo 2016-02-09 19:16:18 +01:00
Makefile moved documentation to new repo 2016-02-09 19:16:18 +01:00
README.md moved documentation to new repo 2016-02-09 19:16:18 +01:00
requirements.txt moved documentation to new repo 2016-02-09 19:16:18 +01:00

Coming soon: Read the nicely-formatted long-form 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 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.