ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-18 18:15:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f31ca2860fb5f045b618aa05d1e76c7e2e9494ec
rippled/docs/README.md
Mike Ellery 755849115e Add dev docs generation to Jenkins: 
Fixes: RIPD-1521

Switch to pure doxygen HTML for developer docs. Remove docca/boostbook
system. Convert consensus document to markdown. Add existing markdown
files to doxygen input set. Fix some image paths and scale images for
use with MD links. Rename/cleanup some files for consistency.
Add pipeline logic for windows slaves. Add ninja and parallel test run
option. Add make doc target build in build-and-test.sh. Cleanup README
files. Add nounity windows build. Add link to jenkins summary table.
Add rippled_classic build (win). Improve formatting of summary table.
2018-03-02 07:37:15 -08:00

2.3 KiB
Raw Blame History

Building documentation

Specifying Files

To specify the source files for which to build documentation, modify INPUT and its related fields in docs/source.dox. Note that the INPUT paths are relative to the docs/ directory.

Install Dependencies

Windows

Install these dependencies:

  1. Install Doxygen

MacOS

  1. Install doxygen:
  • Use homebrew to install: brew install doxygen. The executable will be installed in /usr/local/bin which is already in your path.
  • Alternatively, install from here: doxygen. You'll then need to make doxygen available to your command line. You can do this by adding a symbolic link from /usr/local/bin to the doxygen executable. For example, $ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen

Linux

  1. Install doxygen using your package manager OR from source using the links above.

[Optional] Install Plantuml (all platforms)

Doxygen supports the optional use of plantuml to generate diagrams from @startuml sections. We don't currently rely on this functionality for docs, so it's largely optional. Requirements:

  1. Download/install a functioning java runtime, if you don't already have one.
  2. Download plantuml from here. Set a system environment variable named PLANTUML_JAR with a value of the fullpath to the file system location of the plantuml.jar file you downloaded.

Do it

all platforms

From the rippled root folder:

cd docs
mkdir -p html_doc
doxygen source.dox

The output will be in docs/html_doc.

Docker

(applicable to all platforms)

Instead of installing the doxygen tools locally, you can use the provided Dockerfile to create an ubuntu based image for running the tools:

  1. Install Docker
  2. Build Docker image. From the rippled root folder:
sudo docker build -t rippled-docs docs/

Then to run the image, from the rippled root folder:

sudo docker run -v $PWD:/opt/rippled --rm rippled-docs

The output will be in docs/html_doc.