Add build config for documentation, including RPC docs
ClosedPublic
Actions

Authored by jasonbcox on Jul 20 2020, 16:51.

Details

Reviewers

Fabien
deadalnix

Group Reviewers

Restricted Project

Commits

rABC41e3cc675f40: Add build config for documentation, including RPC docs

Summary

Building documentation should not rely on tests passing in some other
build. This patch splits out docs so they can be reliably built and adds
generating RPC docs to the mix.

Test Plan

build-configurations.py build-docs
ls <build-dir>/artifacts/doc         # verify all doc files are generated correctly

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

jasonbcox created this revision.Jul 20 2020, 16:51

Herald added a reviewer: Restricted Project. · View Herald TranscriptJul 20 2020, 16:51

jasonbcox requested review of this revision.Jul 20 2020, 16:51

Harbormaster completed remote builds in B12068: Diff 22371.Jul 20 2020, 17:15

Fabien requested changes to this revision.Jul 20 2020, 22:23

Fabien added a subscriber: Fabien.

Fabien added inline comments.

contrib/teamcity/builds/build-docs.sh
11 ↗	(On Diff #22371)	You should build bitcoin-cli at the same time to get more parallel builds
21 ↗	(On Diff #22371)	You can run bitcoin-cli help until it returns with success (or timeout), that would be less brittle

This revision now requires changes to proceed.Jul 20 2020, 22:23

Add bitcoin-cli for better parallelism
Make waiting for bitcoind more robust

Harbormaster completed remote builds in B12082: Diff 22394.Jul 21 2020, 03:15

likestamp

Fabien accepted this revision.Jul 21 2020, 09:40

Fabien added inline comments.

contrib/teamcity/builds/build-docs.sh
25 ↗	(On Diff #22394)	Just test the command: if ./src/bitcoin-cli -regtest help > /dev/null; then READY="yes" break fi To get rid of the shellcheck warning