Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prettify file trees in docs #3754

Merged
merged 1 commit into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading