<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Building the documentation — R3 Corda latest documentation</title> <link rel="stylesheet" href="_static/css/custom.css" type="text/css" /> <link rel="top" title="R3 Corda latest documentation" href="index.html"/> <link rel="prev" title="Code style guide" href="codestyle.html"/> <script src="_static/js/modernizr.min.js"></script> </head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search"> <a href="index.html" class="icon icon-home"> R3 Corda </a> <div class="version"> latest </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <br> <a href="api/index.html">API reference</a> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <p class="caption"><span class="caption-text">Overview</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="inthebox.html">What’s included?</a></li> <li class="toctree-l1"><a class="reference internal" href="getting-set-up.html">Getting set up</a></li> <li class="toctree-l1"><a class="reference internal" href="data-model.html">Data model</a></li> <li class="toctree-l1"><a class="reference internal" href="transaction-data-types.html">Transaction Data Types</a></li> <li class="toctree-l1"><a class="reference internal" href="consensus.html">Consensus Model</a></li> <li class="toctree-l1"><a class="reference internal" href="messaging.html">Networking and messaging</a></li> <li class="toctree-l1"><a class="reference internal" href="running-the-demos.html">Running the demos</a></li> <li class="toctree-l1"><a class="reference internal" href="node-administration.html">Node administration</a></li> <li class="toctree-l1"><a class="reference internal" href="irs.html">The Interest Rate Swap Contract</a></li> </ul> <p class="caption"><span class="caption-text">Tutorials</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="where-to-start.html">Where to start</a></li> <li class="toctree-l1"><a class="reference internal" href="tutorial-contract.html">Writing a contract</a></li> <li class="toctree-l1"><a class="reference internal" href="protocol-state-machines.html">Protocol state machines</a></li> <li class="toctree-l1"><a class="reference internal" href="oracles.html">Writing oracle services</a></li> </ul> <p class="caption"><span class="caption-text">Appendix</span></p> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="release-process.html">Release process</a></li> <li class="toctree-l1"><a class="reference internal" href="release-process.html#steps-to-cut-a-release">Steps to cut a release</a></li> <li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release notes</a></li> <li class="toctree-l1"><a class="reference internal" href="visualiser.html">Using the visualiser</a></li> <li class="toctree-l1"><a class="reference internal" href="codestyle.html">Code style guide</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Building the documentation</a><ul> <li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li> <li class="toctree-l2"><a class="reference internal" href="#build">Build</a></li> </ul> </li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">R3 Corda</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html">Docs</a> »</li> <li>Building the documentation</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/building-the-docs.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="building-the-documentation"> <h1>Building the documentation<a class="headerlink" href="#building-the-documentation" title="Permalink to this headline">¶</a></h1> <p>The documentation is under the <code class="docutils literal"><span class="pre">docs</span></code> folder, and is written in reStructuredText format. Documentation in HTML format is pre-generated, as well as code documentation, and this can be done automatically via a provided script.</p> <div class="section" id="requirements"> <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> <p>To build the documentation, you will need:</p> <ul class="simple"> <li>GNU Make</li> <li>Python and pip (tested with Python 2.7.10)</li> <li>Dokka: <a class="reference external" href="https://github.com/Kotlin/dokka">https://github.com/Kotlin/dokka</a></li> <li>Sphinx: <a class="reference external" href="http://www.sphinx-doc.org/">http://www.sphinx-doc.org/</a></li> <li>sphinx_rtd_theme: <a class="reference external" href="https://github.com/snide/sphinx_rtd_theme">https://github.com/snide/sphinx_rtd_theme</a></li> </ul> <p>The Dokka JAR file needs to be placed under the <code class="docutils literal"><span class="pre">lib</span></code> directory within the <code class="docutils literal"><span class="pre">r3prototyping</span></code> directory, in order for the script to find it, as in:</p> <div class="highlight-shell"><div class="highlight"><pre><span></span>r3prototyping/lib/dokka.jar </pre></div> </div> <p>Note that to install under OS X El Capitan, you will need to tell pip to install under <code class="docutils literal"><span class="pre">/usr/local</span></code>, which can be done by specifying the installation target on the command line:</p> <div class="highlight-shell"><div class="highlight"><pre><span></span>sudo -H pip install --install-option <span class="s1">'--install-data=/usr/local'</span> Sphinx sudo -H pip install --install-option <span class="s1">'--install-data=/usr/local'</span> sphinx_rtd_theme </pre></div> </div> </div> <div class="section" id="build"> <h2>Build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h2> <p>Once the requirements are installed, you can automatically build the HTML format user documentation and the API documentation by running the following script:</p> <div class="highlight-shell"><div class="highlight"><pre><span></span>scripts/generate-docsite.sh </pre></div> </div> <p>Alternatively you can build non-HTML formats from the <code class="docutils literal"><span class="pre">docs</span></code> folder. Change directory to the folder and then run the following to see a list of all available formats:</p> <div class="highlight-shell"><div class="highlight"><pre><span></span>make </pre></div> </div> <p>For example to produce the documentation in HTML format:</p> <div class="highlight-shell"><div class="highlight"><pre><span></span>make html </pre></div> </div> </div> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="codestyle.html" class="btn btn-neutral" title="Code style guide" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2016, Distributed Ledger Group, LLC. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'latest', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); </script> </body> </html>