Skip to content

Commit

Permalink
test: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
berezinant committed Jan 17, 2024
1 parent 3511bf9 commit 940f9e0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
2 changes: 1 addition & 1 deletion testDokka.sh
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ echo "TestDokka: $TEST_PROJECT_PATH/build/dokka/html"

python3 -m http.server "$PORT"

echo "TestDokka: Done"
echo "TestDokka: Done"
9 changes: 9 additions & 0 deletions testDokka.sh.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ By default it applied to the `./examples/gradle/dokka-gradle-example` project
./testDokka.sh -d ./examples/gradle/dokka-gradle-example -v 1.9.20-my-fix-SNAPSHOT -p 8001
```

### Apply to a multi-module project

```bash
./testDokka.sh -m
```


## Requirements
To run the server you need to have Python 3 installed.
Expand All @@ -48,3 +54,6 @@ To run the server you need to have Python 3 installed.
* If occurs `Could not resolve all files for configuration ':dokkaHtmlPlugin'` error,
* then make sure that `mavenLocal()` is added to the `repositories` section of the `build.gradle` file of the project you are testing against.
It is not automated and should be done manually.

* if occurs `Failed to write org.jetbrains.dokka.base.renderers.FileWriter@628cef4a. Parent job is Cancelling`
* then try to change the dokka version specified by `-v` parameter (e.g. `-v 1.9.20-my-fix1-SNAPSHOT`)

0 comments on commit 940f9e0

Please sign in to comment.