From d06e265fbf588e2f3b0d288d2f5c932660ad5c0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Sat, 18 Jan 2025 11:36:32 +0100 Subject: [PATCH 1/2] build(website): Fix indentation of embedded Dokka --- docs/website/mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 4187fcb..a57e0e2 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -89,8 +89,8 @@ nav: - Getting started: - setup.md - # !!! EMBEDDED DOKKA START, DO NOT COMMIT !!! # - # !!! EMBEDDED DOKKA END, DO NOT COMMIT !!! # +# !!! EMBEDDED DOKKA START, DO NOT COMMIT !!! # +# !!! EMBEDDED DOKKA END, DO NOT COMMIT !!! # - Reference (plugin API): - reference.md -- 2.51.2 From 8c6c4a3d9171d78082991466ac00e38b73b56373 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Sat, 18 Jan 2025 11:40:59 +0100 Subject: [PATCH 2/2] feat(website): Update the setting up guide to recommend Dokka 2.0 instead of Dokkatoo --- docs/website/docs/setup.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/website/docs/setup.md b/docs/website/docs/setup.md index 7cb78aa..e51f4aa 100644 --- a/docs/website/docs/setup.md +++ b/docs/website/docs/setup.md @@ -1,6 +1,6 @@ # Configuration -This project takes the form of a Gradle plugin which extracts information using Dokkatoo then embeds it into a [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) site. +This project takes the form of a Gradle plugin which extracts information using Dokka then embeds it into a [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) site. ## Creating the project @@ -21,28 +21,28 @@ your-project/ settings.gradle.kts ``` -You will also need to configure [Dokkatoo](https://github.com/adamko-dev/dokkatoo) for your project. You can follow the official documentation and use any of the official formats to test your configuration (e.g. the HTML format). +You will also need to configure Dokka for your project. You can follow the official documentation and use any of the official formats to test your configuration (e.g. the HTML format). However, note that only Dokka in 2.0 mode is compatible. ## Configuring Gradle Locate the `mkdocs.yml` file. In the same directory, create a `build.gradle.kts` file: ```kotlin title="build.gradle.kts in the same folder as mkdocs.yml" -id("dev.opensavvy.dokkatoo-mkdocs") version "VERSION HERE" //(1)! +id("dev.opensavvy.dokka-mkdocs") version "VERSION HERE" //(1)! dependencies { // Embeds the documentation from project :foo-bar - dokkatoo(project("foo-bar")) + dokka(project("foo-bar")) } ``` -1. Latest version:
All versions: [Release list](https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/releases) +1. Latest version:
All versions: [Release list](https://gitlab.com/opensavvy/automation/dokka-material-mkdocs/-/releases) Each Gradle project that you want to include in the website should be added to the `dependencies` block. You may include as many projects as you want. -Each project mentioned needs to be configured to generate documentation with Dokkatoo, see the Dokkatoo documentation for more information. If you can see the documentation from the project in another format (e.g. Dokkatoo HTML), it is configured properly. +Each project mentioned needs to be configured to generate documentation with Dokka, see the Dokka documentation for more information. If you can see the documentation from the project in another format (e.g. Dokka HTML), it is configured properly. -Projects that are not mentioned in the `dependencies` block do not need to be configured to use Dokkatoo. +Projects that are not mentioned in the `dependencies` block do not need to be configured to use Dokka. Don't forget to include the project you created into your Gradle build: ```kotlin title="Root settings.gradle.kts" -- 2.51.2