wilsonianb / rippled-docs

Docker image for building rippled HTML docs

Rippled Documentation Builder

Docker image for building rippled HTML docs.

Dependencies

• docker

Run

docker run -e GIT_REMOTE=ripple -e GIT_BRANCH=master -e "INPUT_PATHS=../src/ripple/app/ ../src/ripple/protocol/STObject.h" -v $PWD:/opt/docs --rm bwilsonripple/rippled-docs:latest

After building the docs, an html folder will be copied to your current working directory. Navigate to the html/index.html file in your browser to see the docs.

Substitute GIT_REMOTE and/or GIT_BRANCH to build docs for your own branch. Substitute INPUT_PATHS to specify the source files to include in the documentation (paths are relative to docs/).

Allergic to Docker?

Reference the Dockerfile and build_docs.sh files in this repo for instructions for building rippled docs locally.