Skip to content

cornelius/rpc-docs-helper

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
test_data
test_data
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
TODO.md
TODO.md
 
 
annotations-bitcoin-0.17.json
annotations-bitcoin-0.17.json
 
 
annotations-bitcoin-0.18.json
annotations-bitcoin-0.18.json
 
 
annotations.py
annotations.py
 
 
cli_bitcoin.py
cli_bitcoin.py
 
 
cli_caller.py
cli_caller.py
 
 
cli_controller.py
cli_controller.py
 
 
generator.py
generator.py
 
 
help_data.py
help_data.py
 
 
help_parser.py
help_parser.py
 
 
references.py
references.py
 
 
renderer_markdown.py
renderer_markdown.py
 
 
renderer_rst.py
renderer_rst.py
 
 
requirements.txt
requirements.txt
 
 
rpc_docs_helper
rpc_docs_helper
 
 
test_help_data.py
test_help_data.py
 
 
test_help_parser.py
test_help_parser.py
 
 
test_renderer_markdown.py
test_renderer_markdown.py
 
 
test_renderer_rst.py
test_renderer_rst.py
 
 

Repository files navigation

This repository contains a tool to generate Bitcoin Core RPC documentation. It requires a running bitcoin-cli client and puts out the documentation in Markdown format as used on bitcoin.org.

Run rpc-docs-helper to get command line help. Run rpc-docs-helper generate to generate the markdown. Run pytest to run the unit tests if you want to work on the tool itself.

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

3 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages