From 8ef365f60511ac46e8a8bb13562fab4f1de96f6d Mon Sep 17 00:00:00 2001
From: Marcin Aman <marcin.aman@gmail.com>
Date: Mon, 19 Apr 2021 13:00:31 +0200
Subject: Update documentation with suppressGeneratedFiles and webserver
---
docs/src/doc/docs/user_guide/base-specific/frontend.md | 6 ++++++
docs/src/doc/docs/user_guide/gradle/usage.md | 4 ++++
2 files changed, 10 insertions(+)
(limited to 'docs/src')
diff --git a/docs/src/doc/docs/user_guide/base-specific/frontend.md b/docs/src/doc/docs/user_guide/base-specific/frontend.md
index a9fd660f..f6155085 100644
--- a/docs/src/doc/docs/user_guide/base-specific/frontend.md
+++ b/docs/src/doc/docs/user_guide/base-specific/frontend.md
@@ -1,5 +1,11 @@
# Configuration specific to HTML format
+## Prerequisites
+
+Dokka's Html format requires a web server to view documentation correctly.
+This can be achieved by using the one that is build in Intellij or providing your own.
+If this requisite is not fulfilled Dokka with fail to load navigation pane and search bars.
+
!!! important
Concepts specified below apply only to configuration of the Base Plugin (that contains Html format)
and needs to be applied via pluginsConfiguration and not on the root one.
diff --git a/docs/src/doc/docs/user_guide/gradle/usage.md b/docs/src/doc/docs/user_guide/gradle/usage.md
index 1473d928..d7210849 100644
--- a/docs/src/doc/docs/user_guide/gradle/usage.md
+++ b/docs/src/doc/docs/user_guide/gradle/usage.md
@@ -202,6 +202,10 @@ dokkaHtml {
matchingRegex.set(""".*\.internal.*""") // will match all .internal packages and sub-packages
suppress.set(true)
}
+
+ // Include generated files in documentation
+ // By default Dokka will omit all files in folder named generated that is a child of buildDir
+ suppressGeneratedFiles.set(false)
}
// Configures a plugin separately from the global configuration
pluginConfiguration<PluginClass, ConfigurationClass>{
--
cgit