Skip to content

Commit

Permalink
Prettify file trees in docs (#3754)
Browse files Browse the repository at this point in the history
Minor docs formatting update, so that the file trees look better. E.g. use `└` for the last file in a list instead of `├`.

I know these docs are probably going to be outdated soon, but the file trees not being pretty bugs me a little.

I used https://tree.nathanfriend.io/ to update the trees.
  • Loading branch information
adam-enko authored Aug 20, 2024
1 parent 67c2c9e commit 0bdff4b
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 57 deletions.
110 changes: 56 additions & 54 deletions docs/topics/runners/dokka-gradle.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,13 +142,14 @@ By default, you can find ready-to-use documentation under `{parentProject}/build
Given a project with the following structure:

```text
parentProject
└── childProjectA
├── demo
├── ChildProjectAClass
└── childProjectB
├── demo
├── ChildProjectBClass
.
└── parentProject/
├── childProjectA/
│ └── demo/
│ └── ChildProjectAClass
└── childProjectB/
└── demo/
└── ChildProjectBClass
```

These pages are generated after running `dokkaHtmlMultiModule`:
Expand Down Expand Up @@ -179,13 +180,14 @@ build that contains all declarations from the subprojects.
Given a project with the following structure:

```text
parentProject
└── childProjectA
├── demo
├── ChildProjectAClass
└── childProjectB
├── demo
├── ChildProjectBClass
.
└── parentProject/
├── childProjectA/
│ └── demo/
│ └── ChildProjectAClass
└── childProjectB/
└── demo/
└── ChildProjectBClass
```

These pages are generated after running `dokkaHtmlCollector`:
Expand Down Expand Up @@ -306,15 +308,15 @@ Multiplatform:
```text
.
├── build.gradle.kts
└── src
── commonMain
└── kotlin
└── Common.kt
── jvmMain
└── kotlin
└── JvmUtils.kt
└── nativeMain
└── kotlin
└── src/
── commonMain/
└── kotlin/
└── Common.kt
── jvmMain/
└── kotlin/
└── JvmUtils.kt
└── nativeMain/
└── kotlin/
└── NativeUtils.kt
```

Expand All @@ -337,15 +339,15 @@ Multiplatform:
```text
.
├── build.gradle
└── src
── commonMain
└── kotlin
└── Common.kt
── jvmMain
└── kotlin
└── JvmUtils.kt
└── nativeMain
└── kotlin
└── src/
── commonMain/
└── kotlin/
└── Common.kt
── jvmMain/
└── kotlin/
└── JvmUtils.kt
└── nativeMain/
└── kotlin/
└── NativeUtils.kt
```

Expand Down Expand Up @@ -479,17 +481,17 @@ typically have the following structure:
.
├── build.gradle.kts
├── settings.gradle.kts
├── subproject-A
── build.gradle.kts
└── src
└── main
└── kotlin
└── HelloFromA.kt
── subproject-B
── build.gradle.kts
└── src
└── main
└── kotlin
├── subproject-A/
── build.gradle.kts
└── src/
└── main/
└── kotlin/
└── HelloFromA.kt
── subproject-B/
── build.gradle.kts
└── src/
└── main/
└── kotlin/
└── HelloFromB.kt
```

Expand All @@ -500,17 +502,17 @@ typically have the following structure:
.
├── build.gradle
├── settings.gradle
├── subproject-A
── build.gradle
└── src
└── main
└── kotlin
└── HelloFromA.kt
── subproject-B
── build.gradle
└── src
└── main
└── kotlin
├── subproject-A/
── build.gradle
└── src/
└── main/
└── kotlin/
└── HelloFromA.kt
── subproject-B/
── build.gradle
└── src/
└── main/
└── kotlin/
└── HelloFromB.kt
```

Expand Down
6 changes: 3 additions & 3 deletions dokka-subprojects/plugin-versioning/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,10 @@ Note that the directory passed to `olderVersionsDir` needs to follow a specific
```text
.
└── olderVersionsDir
── 1.7.10
── <dokka output>
── 1.7.10
── <dokka output>
└── 1.7.20
── <dokka output>
── <dokka output>
...
```

Expand Down

0 comments on commit 0bdff4b

Please sign in to comment.