Practical overview
When it fits
Use the hosted site for reference lookup; use the repository when reviewing or contributing documentation, or when you need a local HTML rendering.
Who it is for
- Developers looking up Bitcoin technical or RPC documentation
- Readers who want to report documentation problems or propose corrections
- Contributors who want to render the documentation locally
Documented uses
- Consult Bitcoin developer references and RPC command documentation.
- Find inconsistencies in terminology, style, or illustrations and propose corrections.
- Generate a local static HTML rendering of the documentation.
Requirements & limits
- Documentation sources include Markdown and reStructuredText, with Sphinx used to render the material.
- The local build requires installing the repository's listed dependencies before running the documented make target.
- RPC documentation changes should be made through the helper tool or backported to it.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Build a local static documentation preview
Render the repository's documentation as locally viewable HTML.
Before you start
- A checkout of the developer.bitcoin.org repository
- Python and the repository's required Sphinx and theme modules
Steps
From the repository root, install the listed dependencies with the command below.
pip install -r requirements.txtRun the command below.
make htmlOpen
_build/html/index.htmlin a browser.
Expected outcome
Static HTML documentation that can be viewed locally.
Guide limitations
- The guide covers rendering the documentation, not packaging it as a searchable offline bundle.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 17 October 2026
- Original website title
- bitcoin-dot-org/developer.bitcoin.org · Official homepage title · retained in its source language

