mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
25 lines
1.7 KiB
Markdown
25 lines
1.7 KiB
Markdown
- [Documentation on ReadTheDocs](http://bigchaindb.readthedocs.org/)
|
|
- [BigchainDB Upgrade Guides](upgrade-guides/)
|
|
|
|
# The BigchainDB Documentation Strategy
|
|
|
|
* Include explanatory comments and docstrings in your code. Write [Google style docstrings](https://google.github.io/styleguide/pyguide.html?showone=Comments#Comments) 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](https://help.github.com/categories/writing-on-github/). 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](http://www.sphinx-doc.org/en/stable/) to generate the long-form documentation in various formats (e.g. HTML, PDF).
|
|
* We also use [Sphinx](http://www.sphinx-doc.org/en/stable/) 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](https://pythonhosted.org/sphinxcontrib-httpdomain/).
|
|
|
|
# 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:
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
You can then generate the HTML documentation _in that subdirectory_ by doing:
|
|
```bash
|
|
make html
|
|
```
|
|
|
|
It should tell you where the generated documentation (HTML files) can be found. You can view it in your web browser.
|