diff options
| author | Marcin Aman <maman@virtuslab.com> | 2020-07-21 13:09:01 +0200 |
|---|---|---|
| committer | Sebastian Sellmair <34319766+sellmair@users.noreply.github.com> | 2020-07-23 15:28:20 +0200 |
| commit | 4f11bcdb2bc8378a015663f9268984283ea18aad (patch) | |
| tree | 99774b9247e687b9d2e5660fa8175fa75aa5858b | |
| parent | 5065c969e9f07086719b44d89686129f7e3504f8 (diff) | |
| download | dokka-4f11bcdb2bc8378a015663f9268984283ea18aad.tar.gz dokka-4f11bcdb2bc8378a015663f9268984283ea18aad.tar.bz2 dokka-4f11bcdb2bc8378a015663f9268984283ea18aad.zip | |
Include publishing information in CONTRIBUTING.md
| -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. |