Repository files navigation

Live site:developer.bitcoin.org

Report problems or help improve the site by opening anewissue orpullrequest.

This repo hosts the sources for the Bitcoin developer documentation. One of theeasiest ways to get started contributing is by rereading the site and looking forinconsistencies in terminology, style, etc., and also in any illustrations.

Prior to contributing, please review thestyleguide.

Much of the content displayed on the is converted from Markdown toreStructuredText (RST) and renderedwithSphinx.

To render the documentation locally you first need to install Sphinx and therequired theme modules, e.g. by running

pip install -r requirements.txt

This should be done from the root of this repo. Then you can execute Sphinx by calling

make html

This will generate HTML from the RST sources in the directory_build/html.It's all static HTML so you can just open the index.html file in your browserlocally to view the rendered documentation.

The documentation of the RPC commands is automatically generated from the helpof a bitcoin client with ahelpertool.This is the content in thereference/rpc directory. Changes inthese files need to be done through the helper tool or at least backported tothe helper tool after doing them in this repo.

Participation in this project is subject to aCode ofConduct.