mirror of
https://github.com/corda/corda.git
synced 2025-02-11 21:26:23 +00:00
0551ba992b
* updated README so that it has a reference to the rst docs we care about * adding some upgrade nodes for cordapps that have a lib/quasar.jar
15 lines
569 B
Markdown
15 lines
569 B
Markdown
# 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](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
|
|
to get your head around the rst syntax we're using.
|
|
|