ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-01 00:45:59 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
corda/docs
History
josecoll 94d827ebe4
CORDA-2741 RPC client connection management section not fully working (#4870) 
* RPC Client using HA addresses.

* Fix incorrect document code snippets by referencing working, compilable code.

* Minor updates following PR review.
2019-03-13 16:31:28 +00: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-2741 RPC client connection management section not fully working (#4870)
2019-03-13 16:31:28 +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
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
fix issue with api docs
2019-01-30 15:33:46 +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
CORDA-2728: Add Quasar lib update step to applicataion upgrade notes (#4877)
2019-03-13 16:23:31 +00:00
requirements.txt
CORDA-2350 update urllib version (#4436)
2018-12-19 07:58:08 +00:00

README.md

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.