move :docs into modules dir (#93)

adamko-dev · Jun 14, 2023 · bab7297 · bab7297
1 parent b1e6062
commit bab7297
Show file tree

Hide file tree

Showing 10 changed files with 8 additions and 9 deletions.
diff --git a/.github/workflows/deploy-site.yml b/.github/workflows/deploy-site.yml
@@ -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

diff --git a/README.md b/README.md
@@ -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
@@ -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
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -35,4 +35,4 @@ idea {
   }
 }
 
-initIdeProjectLogo("docs/images/logo-icon.svg")
+initIdeProjectLogo("modules/docs/images/logo-icon.svg")
diff --git a/docs/build.gradle.kts → modules/docs/build.gradle.kts b/docs/build.gradle.kts → modules/docs/build.gradle.kts
diff --git a/docs/images/banner.svg → modules/docs/images/banner.svg b/docs/images/banner.svg → modules/docs/images/banner.svg
diff --git a/docs/images/logo-icon.svg → modules/docs/images/logo-icon.svg b/docs/images/logo-icon.svg → modules/docs/images/logo-icon.svg
diff --git a/docs/images/social_preview_banner.png → ...les/docs/images/social_preview_banner.png b/docs/images/social_preview_banner.png → ...les/docs/images/social_preview_banner.png
diff --git a/docs/images/social_preview_banner.svg → ...les/docs/images/social_preview_banner.svg b/docs/images/social_preview_banner.svg → ...les/docs/images/social_preview_banner.svg
diff --git a/docs/style/logo-styles.css → modules/docs/style/logo-styles.css b/docs/style/logo-styles.css → modules/docs/style/logo-styles.css
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -36,9 +36,9 @@ dependencyResolutionManagement {
 }
 
 include(
-  ":docs",
   ":examples",
 
+  ":modules:docs",
   ":modules:dokkatoo-plugin",
   ":modules:dokkatoo-plugin-integration-tests",
 )