b80aaa0e9d
Removed redundant parts of the docsite generator. Gradle now calls the docsite requirements installation script when building docs via buildDocs Added docs build script and moved all docs building related code into it Corrected directories for build.
1.6 KiB
Building the documentation
The documentation is under the docs 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.
Requirements
To build the documentation, you will need:
- GNU Make
- Python and pip (tested with Python 2.7.10)
- Dokka: https://github.com/Kotlin/dokka
- Sphinx: http://www.sphinx-doc.org/
- sphinx_rtd_theme: https://github.com/snide/sphinx_rtd_theme
The Dokka JAR file needs to be placed under the lib
directory within the r3prototyping directory, in order for
the script to find it, as in:
corda/lib/dokka.jarNote that to install under OS X El Capitan, you will need to tell pip
to install under /usr/local, which can be done by
specifying the installation target on the command line:
sudo -H pip install --install-option '--install-data=/usr/local' Sphinx
sudo -H pip install --install-option '--install-data=/usr/local' sphinx_rtd_themeBuild
Once the requirements are installed, you can automatically build the HTML format user documentation and the API documentation by running the following script:
./gradlew buildDocsAlternatively you can build non-HTML formats from the
docs folder. Change directory to the folder and then run
the following to see a list of all available formats:
makeFor example to produce the documentation in HTML format:
make html