ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-06-17 14:48:16 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Rebuild user documentation

Browse Source
This commit is contained in:
Ross Nicoll
2016-04-28 17:15:56 +01:00
parent c13b5f247e
commit 31da33425e
10 changed files with 155 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/build/html/building-the-docs.html vendored
View File

@ -31,8 +31,7 @@
<link rel="top" title="R3 Prototyping latest documentation" href="index.html"/>
<link rel="next" title="Protocol state machines" href="protocol-state-machines.html"/>
<link rel="prev" title="Writing a contract" href="tutorial.html"/>
<link rel="prev" title="Code style guide" href="codestyle.html"/>
<script src="_static/js/modernizr.min.js"></script>
@ -96,20 +95,20 @@
<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 class="current">
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial.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="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>
<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>
<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>
</ul>
@ -156,23 +155,25 @@
<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 &#8220;docs&#8221; folder, and is written in reStructuredText format. Documentation in HTML format
<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</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 is expected to be placed under the &#8220;lib&#8221; directory, called:</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>lib/dokka.jar
<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 /usr/local, for example:</p>
<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">&#39;--install-data=/usr/local&#39;</span> Sphinx
sudo -H pip install --install-option <span class="s1">&#39;--install-data=/usr/local&#39;</span> sphinx_rtd_theme
</pre></div>
@ -180,15 +181,18 @@ sudo -H pip install --install-option <span class="s1">&#39;--install-data=/usr/l
</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 manually build the documentation by changing to the &#8220;docs&#8221; folder, and
running make, for example to produce the documentation in HTML format:</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>make html
<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>If you type &#8220;make&#8221; by itself, it will list the possible build targets (formats).</p>
<p>Alternatively, the full documentation in HTML format, as well as the API documentation can be built by running the
following script:</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>scripts/generate-docsite.sh
<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>
@ -201,10 +205,8 @@ following script:</p>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="protocol-state-machines.html" class="btn btn-neutral float-right" title="Protocol state machines" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="tutorial.html" class="btn btn-neutral" title="Writing a contract" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<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>