ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-20 09:26:41 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Update README.md - minor changes, add daemon (#5030)

Browse Source 
Changes:
* Process described in stepwise manner
* Addition of daemon selection step
* Minor formatting and phrasing changes
This commit is contained in:
ChrissyAtWork 2019-04-17 09:29:00 +01:00 committed by Anthony Keenan
parent 69526229e1
commit 870c930142
1 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/README.md
View File

@ -1,20 +1,29 @@
# Corda Documentation Build
To run the Corda Documentation build run ``./gradlew makeDocs``
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.
Note: In order to run the documentation build you will need Docker installed.
## Prerequisites / First time build
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'.
Before you begin, you need to:
1. Install Docker.
1. Ensure that Docker is running.
1. 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**)
## rst style guide
## Build process
1. Open a cmd dialogue.
1. Navigate to the root location (this is the `\corda` directory)
1. Run the documentation build (`gradlew makeDocs` or `./gradlew makeDocs`)
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.
**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'.*
## version placeholders
# RST style guide
Currently we support five placeholders that get substituted at build time:
The Corda documentation is described using the ReStructured Text (RST) markup language. For details of the syntax, see [this](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html).
# Version placeholders
We currently support the following placeholders; they get substituted with the correct value at build time:
```groovy
"|corda_version|"
@ -24,10 +33,7 @@ Currently we support five placeholders that get substituted at build time:
"|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
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.
The code for this can be found near the top of the conf.py file in the `docs/source` directory.