corda/docs
Chris Rankin a7147c1ffd ENT-4652: Provide an "attachment fixup" mechanism to repair broken transactions. (#5825)
* Do not register cordapp custom serialisers when using attachment classloader.

* Record the URLs of CorDapp JARs that contain custom serialisers. Include these JARs as extra attachments if we discover that we're missing a custom serialiser during transaction verification.

* Check for disabled serializer when explicitly requesting a custom serializer.
Refactor test case to force use of a custom serializer.

* Tidy up basic custom serializer test.

* Also test that TransactionBuilder rejects missing custom serializers.

* Remove test whitelists, which should not be needed with custom serialisers.

* Add changelog entry. Also align TestCordappImpl.findRoots() with OS backports.

* Second approach based around CorDapps inside AttachmentStorage - report missing type descriptor or any non-composable types.

* Initial implementation of Corda-Fixup rules inside a CorDapp jar.

* Replace original "automatic attachment fixing" mechanism completely.

* First review comments: restore "missing class" logic to TransactionBuilder.

* Restore "missing class" mechanism as fallback for SignedTransaction too.
2020-01-14 15:18:51 +00:00
..
docs_builder Document warning cleanup + new version of docs builder 2019-04-11 13:43:47 +00:00
ext CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674) 2018-07-24 10:05:57 +01:00
source ENT-4652: Provide an "attachment fixup" mechanism to repair broken transactions. (#5825) 2020-01-14 15:18:51 +00: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 updated jackson-core api documentation to 2.9 2019-05-08 11:48:09 +02: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 Fix corda docker image names in docs (#5606) 2019-10-18 10:46:59 +01:00
requirements.txt Bump pillow from 5.1.0 to 6.2.0 in /docs (#5632) 2019-10-30 16:37:59 +00:00

Corda Documentation Build

This Readme describes how to build the Corda documentation for the current version. The output html files will be written to the corda\docs\build\html directory.

Prerequisites / First time build

Before you begin, you need to:

  1. Install Docker.
  2. Ensure that Docker is running.
  3. Select Expose daemon on tcp://localhost:2375 without TLS in the Docker Settings (which you can open from the System Tray by right-clicking the Docker symbol and then selecting Settings)

Build process

  1. Open a cmd dialogue.
  2. Navigate to the root location (this is the \corda directory)
  3. Run the documentation build (gradlew makeDocs or ./gradlew makeDocs)

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

The Corda documentation is described using the ReStructured Text (RST) markup language. For details of the syntax, see this.

Version placeholders

We currently support the following placeholders; they get substituted with the correct value at build time:

    "|corda_version|" 
    "|corda_version_lower|" 
    "|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), it will be substituted with the value from constants.properties (which is in the root of the project) at build time. corda_version_lower returns the current Corda version in lowercase which is useful for case sensitive artifacts such as docker images.

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