ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-14 16:15:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ec8626046bfb6e11145c4ab65149daba5518a812
rippled/docs
History
David Fuelling 67238b9fa6 Update environment.md build doc to install lzma: (#4498) 
On macOS, if you have not installed something that depends on `xz`, then your
system may lack `lzma`, resulting in a build error similar to:

```
Downloading libarchive-3.6.0.tar.xz completed [6250.61k]
libarchive/3.6.0: 
ERROR: libarchive/3.6.0: Error in source() method, line 120
        get(self, **self.conan_data["sources"][self.version], strip_root=True)
        ReadError: file could not be opened successfully:
- method gz: ReadError('not a gzip file')
- method bz2: ReadError('not a bzip2 file')
- method xz: CompressionError('lzma module is not available')
- method tar: ReadError('invalid header')
```

The solution is to ensure that `lzma` is installed by installing `xz`.
2023-04-27 10:18:59 -07:00
..
0001-negative-unl
Implement negative UNL functionality:
2020-06-30 09:15:37 -07:00
0010-ledger-replay
Implement ledger forward replay
2021-01-25 18:49:49 -08:00
build
Update environment.md build doc to install lzma: (#4498)
2023-04-27 10:18:59 -07:00
images
Set version to 1.5.0
2020-03-30 18:57:35 -04:00
.gitignore
Add HTML documentation framework
2016-10-17 15:18:40 -04:00
CheatSheet.md
Add dev docs generation to Jenkins:
2018-03-02 07:37:15 -08:00
CodingStyle.md
Add .clang-format rules and update code style
2018-07-16 17:49:42 -07:00
consensus.md
Fix typo in consensus.md
2021-12-14 17:47:04 -08:00
Docker.md
Update Docker.md (#4432)
2023-03-02 10:07:09 -08:00
Dockerfile
Fix Doxygen build
2020-04-06 17:28:53 -07:00
Doxyfile
Fix Doxygen build
2020-04-06 17:28:53 -07:00
HeapProfiling.md
Add dev docs generation to Jenkins:
2018-03-02 07:37:15 -08:00
NodeStoreRefactoringCaseStudy.pdf
Add dev docs generation to Jenkins:
2018-03-02 07:37:15 -08:00
README.md
Improve the Doxygen Workflow
2020-04-14 19:42:42 -07:00
sample_chart.doc
Add dev docs generation to Jenkins:
2018-03-02 07:37:15 -08:00

README.md

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/bin which is already in the default PATH.

      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/bin to the doxygen executable. For example,

      $ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen

  • PlantUML:

    1. Install a functioning Java runtime, if you don't already have one.
    2. Download plantuml.jar.

  • Graphviz:

    • 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.

  1. Install Docker
  2. Pull the image:
sudo docker pull rippleci/rippled-ci-builder:2944b78d22db
  1. 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.