tendermint/docs
Ethan Buchman b2489b4318
Merge pull request #912 from bluecollarcoding/fix/docs
docs:clarify py-abci/py-tendermint
2017-12-01 02:57:32 -05:00
..
_static [docs] provide means to have collapsible code blocks without adding a new theme 2017-10-15 11:59:37 +02:00
_templates [docs] provide means to have collapsible code blocks without adding a new theme 2017-10-15 11:59:37 +02:00
architecture added changes based on PR comments to the proposal 2017-11-15 17:59:48 -05:00
assets docs: finish pull from tools 2017-09-16 15:11:10 -04:00
images docs: finish pull from tools 2017-09-16 15:11:10 -04:00
specification docs: fix links, closes #860 2017-11-17 14:03:43 +00:00
Makefile docs: logo, add readme, fixes 2017-09-01 20:08:22 -04:00
README.md docs: logo, add readme, fixes 2017-09-01 20:08:22 -04:00
abci-cli.rst docs: fixup abci guide 2017-10-23 20:56:49 -04:00
app-architecture.rst docs: organize the directory, #656 2017-09-16 15:19:22 -04:00
app-development.rst [docs] add Java examples for each section 2017-10-15 13:45:43 +02:00
conf.py docs: pull from tools' master branch 2017-09-18 12:14:23 -04:00
deploy-testnets.rst docs: comb through step by step 2017-10-23 19:11:51 -04:00
ecosystem.rst docs: correction, closes #910 2017-11-30 18:27:46 +00:00
getting-started.rst Update getting-started.rst to fix broken link 2017-11-21 10:11:48 -05:00
how-to-read-logs.rst relative links [ci skip] 2017-10-04 23:33:31 +04:00
index.rst docs: smaller logo (200px) 2017-10-23 17:34:27 -04:00
install.rst docs/install: add note about putting GOPATH/bin on PATH 2017-11-29 18:05:51 +00:00
introduction.rst docs: comb through step by step 2017-10-23 19:11:51 -04:00
requirements.txt docs: add sphinx Makefile & requirements 2017-08-30 16:37:51 -04:00
specification.rst docs: fix build warnings 2017-10-03 11:23:08 -04:00
using-tendermint.rst docs: comb through step by step 2017-10-23 19:11:51 -04:00

README.md

Here lies our documentation. After making edits, run:

pip install -r requirements.txt
make html

to build the docs locally then open the file _build/html/index.html in your browser.

WARNING: This documentation is intended to be viewed at:

https://tendermint.readthedocs.io

and may contain broken internal links when viewed from Github.