|
| 1 | +# Welcome to developer.bitcoin.org's codebase |
| 2 | + |
| 3 | +Live site: [developer.bitcoin.org](https://developer.bitcoin.org) |
| 4 | + |
| 5 | +Report problems or help improve the site by opening a [new |
| 6 | +issue](https://github.com/bitcoin-dot-org/developer.bitcoin.org/issues) or [pull |
| 7 | +request](https://github.com/bitcoin-dot-org/developer.bitcoin.org/compare). |
| 8 | + |
| 9 | +## How to contribute |
| 10 | + |
| 11 | +This repo hosts the sources for the Bitcoin developer documentation. |
| 12 | + |
| 13 | +It is converted from Markdown to [reStructuredText |
| 14 | +(RST)](http://docutils.sourceforge.net/rst.html) and rendered with |
| 15 | +[Sphinx](http://www.sphinx-doc.org). |
| 16 | + |
| 17 | +### Render the documentation locally |
| 18 | + |
| 19 | +To render the documentation locally you first need to install Sphinx and the |
| 20 | +required theme modules, e.g. by running |
| 21 | + |
| 22 | + pip install -r requirements.txt |
| 23 | + |
| 24 | +from the root of this repo. Then you can execute Sphinx by calling |
| 25 | + |
| 26 | + make html |
| 27 | + |
| 28 | +This will generate HTML from the RST sources in the directory `_build/html`. |
| 29 | +It's all static HTML so you can just open the index.html file in your browser |
| 30 | +locally to view the rendered documentation. |
| 31 | + |
| 32 | +### Generation of RPC docs |
| 33 | + |
| 34 | +The documentation of the RPC commands is automatically generated from the help |
| 35 | +of a bitcoin client with a [helper |
| 36 | +tool](https://github.com/bitcoin-dot-org/developer.bitcoin.org/tree/master/helpers/rpc). |
| 37 | +This is the content in the [reference/rpc](reference/rpc) directory. Changes in |
| 38 | +these files need to be done through the helper tool or at least backported to |
| 39 | +the helper tool after doing them in this repo. |
| 40 | + |
| 41 | +## Code of Conduct |
| 42 | + |
| 43 | +Participation in this project is subject to a [Code of |
| 44 | +Conduct](https://github.com/bitcoin-dot-org/developer.bitcoin.org/blob/master/CODE_OF_CONDUCT.md). |
| 45 | + |
| 46 | +## Donations |
| 47 | + |
| 48 | +This project, developer.bitcoin.org, is community supported: |
| 49 | +[3FkenCiXpSLqD8L79intRNXUgjRoH9sjXa](bitcoin:3FkenCiXpSLqD8L79intRNXUgjRoH9sjXa) |
| 50 | + |
| 51 | +## Questions? |
| 52 | + |
| 53 | +Please contact Will Binns ( [[email protected]](mailto:[email protected])) if you |
| 54 | +need help. |
0 commit comments