diff options
| author | vmishenev <vad-mishenev@yandex.ru> | 2021-11-23 20:01:23 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-11-23 20:01:23 +0300 |
| commit | e24ef5d0b4915505eaa3b06999ab196eac463ea7 (patch) | |
| tree | ecf2cca8a5094bf0a1c22310741dd09675704dde /docs | |
| parent | 8d151d1b5c99cded45bd8d60919b17f797e36116 (diff) | |
| download | dokka-e24ef5d0b4915505eaa3b06999ab196eac463ea7.tar.gz dokka-e24ef5d0b4915505eaa3b06999ab196eac463ea7.tar.bz2 dokka-e24ef5d0b4915505eaa3b06999ab196eac463ea7.zip | |
Add sample project of versioning multi module (#2170)
* Add sample project of versioning multi module
* Add sample task to generate previously docs
* Update Gradle version
* Update Kotlin version
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/doc/docs/user_guide/versioning/versioning.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/src/doc/docs/user_guide/versioning/versioning.md b/docs/src/doc/docs/user_guide/versioning/versioning.md index ad1c8267..d1f4513d 100644 --- a/docs/src/doc/docs/user_guide/versioning/versioning.md +++ b/docs/src/doc/docs/user_guide/versioning/versioning.md @@ -16,7 +16,7 @@ Versioning can be configured using: By default, Dokka renders a versions navigation on all pages. !!! note - You should enable the plugin in all submodules to render a versions navigation on all pages. + You should enable the plugin in all submodules to render a versions navigation on all pages. Above configuration should be placed under the `pluginsConfiguration` block specific for your build tool. Configuration object is named `org.jetbrains.dokka.versioning.VersioningConfiguration`. @@ -44,6 +44,9 @@ together. `olderVersions` directories need to contain a past Dokka output. For the above example, you would pass `older_versions_dir/1.4.10, older_versions_dir/1.4.20`. +!!! note + The previously documentations should be generated with the versioning plugin. + ### Example Versioning plugin in gradle can be configured in 2 ways: @@ -77,3 +80,5 @@ pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.versioning.VersioningPlug ``` Please consult the [Gradle documentation](../gradle/usage.md#applying-plugins) for more information about configuring Dokka with this build tool. + +Please see the [Dokka Gradle versioning multi modules example project](https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-versioning-multimodule-example).
\ No newline at end of file |