corda/docs
Dan Newton cdc29dd4ca CORDA-2477 - Improve Signature Constraints documentation
* CORDA-2477 Improve Signature Constraints documentation (#5041)

The Signature Constraint documentation in `api-contract-constraints`
was very limited and referred to the design doc for most information.
Information was extracted from the design doc and added to the main
documentation.

(cherry picked from commit cb85dd1e92)

* CORDA-2477 Add codesets so backported docs show properly
2019-05-01 11:15:50 +01:00
..
docs_builder do not install documentation with textlive 2019-01-30 15:33:46 +00:00
ext CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674) 2018-07-24 10:05:57 +01:00
source CORDA-2477 - Improve Signature Constraints documentation 2019-05-01 11:15:50 +01:00
.gitattributes dockerize docs building 2019-01-30 15:33:46 +00:00
.gitignore CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674) 2018-07-24 10:05:57 +01:00
build.gradle Fix documentation issues (#4721) 2019-02-06 12:49:47 +00:00
index.html Added a convenience HTML file for redirecting to the main docs. 2016-11-22 11:56:46 +00:00
install-docsite-requirements.sh Make virtualenv installable if the checkout path has whitespace. (#1187) 2017-08-18 13:31:00 +01:00
make-docsite.sh turned of latex warnings so that we can see the warnings wood for the trees (#4956) 2019-03-29 15:43:01 +00:00
Makefile [CORDA-1612]: Fix truncated code snippets in docs PDF (#3347) 2018-06-13 09:43:16 +01:00
packages.md [CORDA-1035] Testing api KDoc Updates (#2584) 2018-02-28 13:26:49 +00:00
README.md put some version related notes in the readme 2019-03-22 15:14:54 +01:00
requirements.txt CORDA-2350 update urllib version (#4436) 2018-12-19 07:58:08 +00:00

Corda Documentation Build

To run the Corda Documentation build run ./gradlew makeDocs

Note: In order to run the documentation build you will need Docker installed.

Windows users: If this task fails because Docker can't find make-docsite.sh, go to Settings > Shared Drives in the Docker system tray agent, make sure the relevant drive is shared, and click 'Reset credentials'.

rst style guide

It's probably worth reading this to get your head around the rst syntax we're using.

version placeholders

Currently we support five placeholders that get substituted at build time:

    "|corda_version|" 
    "|java_version|" 
    "|kotlin_version|" 
    "|gradle_plugins_version|" 
    "|quasar_version|"

If you put one of these in an rst file anywhere (including in a code tag) then it will be substituted with the value in constants.properties (which is in the root of the project) at build time.

The code for this can be found near the top of the conf.py file in the docs/source directory.