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

move :docs into modules dir #93

Merged
merged 1 commit into from
Jun 14, 2023
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
4 changes: 2 additions & 2 deletions .github/workflows/deploy-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ jobs:
with:
gradle-home-cache-cleanup: true
arguments: |
:docs:dokkatooGenerate
:modules:docs:dokkatooGenerate

- uses: actions/upload-pages-artifact@v1
with:
path: ./docs/build/dokka/html
path: ./modules/docs/build/dokka/html

deploy:
needs: build
Expand Down
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Slack](https://img.shields.io/badge/slack-%23dokka-white.svg?&style=for-the-badge&logo=slack)](https://slack-chats.kotlinlang.org/c/dokka)

<picture>
<img alt="Dokkatoo Logo" src="./docs/images/banner.svg" style="margin: 1em">
<img alt="Dokkatoo Logo" src="./modules/docs/images/banner.svg" style="margin: 1em">
</picture>

[Dokkatoo](https://github.com/adamko-dev/dokkatoo) is a Gradle plugin that generates documentation
Expand Down Expand Up @@ -163,11 +163,10 @@ Run the Dokkatoo generation task.
./gradlew :dokkatooGeneratePublicationHtml
```

Only run the task in the aggregating project (prefix the task name with the subproject path)
so that Dokkatoo doesn't generate documentation in other subprojects (it won't cause problems, but
it will be slower.)
Dokkatoo will then generate documentation into `./build/dokka/`

Dokkatoo will then generate documentation into `./docs/build/dokka/`
To improve performance only run the task in the aggregating project by prefixing the task name with
the subproject path (or `:` if aggregating in the root project).

### Migrating from Dokka Gradle Plugin

Expand Down
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ idea {
}
}

initIdeProjectLogo("docs/images/logo-icon.svg")
initIdeProjectLogo("modules/docs/images/logo-icon.svg")
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
2 changes: 1 addition & 1 deletion settings.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ dependencyResolutionManagement {
}

include(
":docs",
":examples",

":modules:docs",
":modules:dokkatoo-plugin",
":modules:dokkatoo-plugin-integration-tests",
)
Expand Down