mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-06 12:15:52 +00:00
706ca874b0
This change can help improve the liveness of the network during periods of network instability, by allowing the network to track which validators are presently not online and to disregard them for the purposes of quorum calculations.
Building documentation
Dependencies
Install these dependencies:
-
Doxygen: All major platforms have official binary distributions, or you can build from source.
-
MacOS: We recommend installing via Homebrew:
brew install doxygen. The executable will be installed in/usr/local/binwhich is already in the defaultPATH.If you use the official binary distribution, then you'll need to make Doxygen available to your command line. You can do this by adding a symbolic link from
/usr/local/binto thedoxygenexecutable. For example,$ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen
-
-
- Install a functioning Java runtime, if you don't already have one.
- Download
plantuml.jar.
-
- Linux: Install from your package manager.
- Windows: Use an official installer.
- MacOS: Install via Homebrew:
brew install graphviz.
Docker
Instead of installing the above dependencies locally, you can use the official build environment Docker image, which has all of them installed already.
- Install Docker
- Pull the image:
sudo docker pull rippleci/rippled-ci-builder:2944b78d22db
- Run the image from the project folder:
sudo docker run -v $PWD:/opt/rippled --rm rippleci/rippled-ci-builder:2944b78d22db
Build
There is a docs target in the CMake configuration.
mkdir build
cd build
cmake ..
cmake --build . --target docs
The output will be in build/docs/html.