Skip to content

Latest commit

 

History

History
41 lines (37 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

41 lines (37 loc) · 2.03 KB

Building Dokka

Dokka is built with Gradle. To build it, use ./gradlew build. Alternatively, open the project directory in IntelliJ IDEA and use the IDE to build and run dokka.

Here's how to import and configure Dokka in IntelliJ IDEA:

  • Select "Open" from the IDEA welcome screen, or File > Open if a project is already open
  • Select the directory with your clone of Dokka
    • Note: IDEA may have an error after the project is initally opened; it is OK to ignore this as the next step will address this error
  • After IDEA opens the project, select File > New > Module from existing sources and select the build.gradle file from the root directory of your Dokka clone
  • Use the default options and select "OK"
  • After Dokka is loaded into IDEA, open the Gradle tool window (View > Tool Windows > Gradle) and click on the top left "Refresh all Gradle projects" button
  • Verify the following project settings. In File > Settings > Build, Execution, Deployment > Build Tools > Gradle > Runner:
    • Ensure "Delegate IDE build/run actions to gradle" is checked
    • "Gradle Test Runner" should be selected in the "Run tests using" drop-down menu
  • Note: After closing and re-opening the project, IDEA may give an error 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.

Using/testing locally built Dokka

If you want to use/test your locally built Dokka in a project, do the following:

  1. Change dokka_version in gradle.properties to something that you will use later on as the dependency version. For instance, you can set it to something like 1.6.10-my-fix-SNAPSHOT.
  2. Publish it to maven local (./gradlew publishToMavenLocal)
  3. In the project you want to generate documentation for, add maven local as a plugin/dependency repository (mavenLocal())
  4. Update your dokka dependency to the version you've just published:
plugins {
    id("org.jetbrains.dokka") version "1.6.10-my-fix-SNAPSHOT"
}