diff options
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9e12ce2..9f8773c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,4 +24,9 @@ Here's how to import and configure Dokka in IntelliJ IDEA: message: "Error Loading Project: Cannot load 3 modules". Open up the details of the error, and click "Remove Selected", as these module `.iml` files are safe to remove. + +In order to publish dokka locally use: `./gradlew publishToMavenLocal` and add `mavenLocal()` to repositories in the project you want to generate documentation for. +This will allow you to run the latest version in your project from local maven repository. +Keep in mind that those builds are postfixed with `-SNAPSHOT`, eg. `1.4.0-rc-SNAPSHOT`, so remember to update plugin version. +Dokka version generated with this build is taken from `gradle.properties` file under `dokka_version_base` and is visible in logs while running `publishToMavenLocal` task. |