Fix Doxygen build

This commit is contained in:
John Freeman
2020-03-16 11:04:06 -05:00
committed by manojsdoshi
parent 758a3792eb
commit 3e9cff9287
7 changed files with 150 additions and 129 deletions

View File

@@ -1,11 +1,5 @@
# 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
@@ -30,32 +24,38 @@ Install these dependencies:
### [Optional] Install Plantuml (all platforms)
Doxygen supports the optional use of [plantuml](http://plantuml.com) to
Doxygen supports the optional use of [plantuml](http://plantuml.com) 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](http://plantuml.com) from
[here](http://sourceforge.net/projects/plantuml/files/plantuml.jar/download).
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.
Set a system environment variable named `DOXYGEN_PLANTUML_JAR_PATH` to
the absolute path of the `plantuml.jar` file you downloaded.
## Do it
### all platforms
## Configure
You should set these environment variables:
- `DOXYGEN_OUTPUT_DIRECTORY`
- `DOXYGEN_PLANTUML_JAR_PATH`
## Build
From the rippled root folder:
```
cd docs
mkdir -p html_doc
doxygen source.dox
doxygen docs/Doxyfile
```
The output will be in `docs/html_doc`.
The output will be wherever you chose for `DOXYGEN_OUTPUT_DIRECTORY`.
## 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:
@@ -72,5 +72,4 @@ 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`.
The output will be in `html`.