mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
119 lines
5.4 KiB
HTML
119 lines
5.4 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: Building documentation</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Building documentation </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><h1><a class="anchor" id="autotoc_md65"></a>
|
|
Dependencies</h1>
|
|
<p>Install these dependencies:</p>
|
|
<ul>
|
|
<li><a href="http://www.doxygen.nl">Doxygen</a>: All major platforms have <a href="http://www.doxygen.nl/download.html#srcbin">official binary distributions</a>, or you can build from <a href="http://www.doxygen.nl/download.html#srcbin">source</a>.<ul>
|
|
<li><p class="startli">MacOS: We recommend installing via Homebrew: <code>brew install doxygen</code>. The executable will be installed in <code>/usr/local/bin</code> which is already in the default <code>PATH</code>.</p>
|
|
<p class="startli">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 <code>/usr/local/bin</code> to the <code>doxygen</code> executable. For example,</p>
|
|
<p class="startli">``` $ ln -s /Applications/Doxygen.app/Contents/Resources/doxygen /usr/local/bin/doxygen ```</p>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="http://plantuml.com">PlantUML</a>:<ol type="1">
|
|
<li>Install a functioning Java runtime, if you don't already have one.</li>
|
|
<li>Download <a href="http://sourceforge.net/projects/plantuml/files/plantuml.jar/download"><code>plantuml.jar</code></a>.</li>
|
|
</ol>
|
|
</li>
|
|
<li><a href="https://www.graphviz.org">Graphviz</a>:<ul>
|
|
<li>Linux: Install from your package manager.</li>
|
|
<li>Windows: Use an <a href="https://graphviz.gitlab.io/_pages/Download/Download_windows.html">official installer</a>.</li>
|
|
<li>MacOS: Install via Homebrew: <code>brew install graphviz</code>.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="autotoc_md66"></a>
|
|
Docker</h1>
|
|
<p>Instead of installing the above dependencies locally, you can use the official build environment Docker image, which has all of them installed already.</p>
|
|
<ol type="1">
|
|
<li>Install <a href="https://docs.docker.com/engine/installation/">Docker</a></li>
|
|
<li>Pull the image: <div class="fragment"><div class="line">sudo docker pull rippleci/rippled-ci-builder:2944b78d22db</div>
|
|
</div><!-- fragment --></li>
|
|
<li>Run the image from the project folder: <div class="fragment"><div class="line">sudo docker run -v $PWD:/opt/rippled --rm rippleci/rippled-ci-builder:2944b78d22db</div>
|
|
</div><!-- fragment --></li>
|
|
</ol>
|
|
<h1><a class="anchor" id="autotoc_md67"></a>
|
|
Build</h1>
|
|
<p>There is a <code>docs</code> target in the CMake configuration.</p>
|
|
<div class="fragment"><div class="line">mkdir build</div>
|
|
<div class="line">cd build</div>
|
|
<div class="line">cmake ..</div>
|
|
<div class="line">cmake --build . --target docs</div>
|
|
</div><!-- fragment --><p>The output will be in <code>build/docs/html</code>. </p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|