Page MenuHomePhabricator
Differential D6382

Add facility to generate RPC docs
ClosedPublic
Actions

Authored by deadalnix on Jun 5 2020, 10:01.

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rABC849a00758477: Add facility to generate RPC docs
Summary

This is a modified version of https://github.com/bitcoin-core/bitcoincore.org/tree/master/contrib/doc-gen so that it fits into our build system.

Test Plan
ninja bitcoind

Run bitcoind as a daemon

ninja doc-rpc

Verify that the RPC doc are generated properly.

ninja clean

Verify that the RPC doc are now gone.

Diff Detail

Event Timeline

deadalnix created this revision.Jun 5 2020, 10:01
Herald added a reviewer: Restricted Project. · View Herald TranscriptJun 5 2020, 10:01
deadalnix requested review of this revision.Jun 5 2020, 10:01
Harbormaster completed remote builds in B11221: Diff 20934.Jun 5 2020, 10:10
Fabien requested changes to this revision.Jun 5 2020, 13:48
Fabien added a subscriber: Fabien.
Fabien added inline comments.
doc/rpc/CMakeLists.txt
11–12

doc/rpc directory

13

Can use CMAKE_CURRENT_LIST_DIR

This revision now requires changes to proceed.Jun 5 2020, 13:48
deadalnix updated this revision to Diff 20935.Jun 5 2020, 13:50

Change erroneous comment

Fabien accepted this revision.Jun 5 2020, 13:55
This revision is now accepted and ready to land.Jun 5 2020, 13:55
Harbormaster completed remote builds in B11222: Diff 20935.Jun 5 2020, 14:01
Closed by commit rABC849a00758477: Add facility to generate RPC docs (authored by deadalnix). · Explain WhyJun 5 2020, 15:31
This revision was automatically updated to reflect the committed changes.
deadalnix added a commit: rABC849a00758477: Add facility to generate RPC docs.
deadalnix mentioned this in D6592: Backport doc-gen from bitcoincore.org.Jun 15 2020, 20:28

Revision Contents
Changeset List

PathSize
doc/
1 line
rpc/
13 lines
8 lines
192 lines

Diff 20934

View Options

doc/CMakeLists.txt

Loading...
View Options

doc/rpc/CMakeLists.txt

Loading...
View Options

doc/rpc/command-template.html

Loading...
View Options

doc/rpc/generate.go

Loading...