Skip to content

Commit 5762271

Browse files
Exclude user guides from mkdocs documentation (#2868)
1 parent 1e10c6f commit 5762271

File tree

16 files changed

+56
-1278
lines changed

16 files changed

+56
-1278
lines changed

mkdocs/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# MkDocs documentation
2+
3+
This module contains documentation which is published to GitHub pages:
4+
[kotlin.github.io/dokka](https://kotlin.github.io/dokka/).
5+
6+
It is built using the [gradle-mkdocs-plugin](https://github.com/xvik/gradle-mkdocs-plugin).
7+
8+
## Building
9+
10+
You can build the documentation locally:
11+
12+
```Bash
13+
./gradlew :mkdocs:mkdocsBuild
14+
```
15+
16+
The output directory is `build/mkdocs`
17+
18+
### Livereload server
19+
20+
Alternatively, you can run a livereload server that automatically rebuilds documentation on every change:
21+
22+
```Bash
23+
./gradlew :mkdocs:mkdocsServe
24+
```
25+
26+
By default, it is run under [127.0.0.1:3001](http://127.0.0.1:3001/), but you can change it in
27+
[mkdocs.yml](src/doc/mkdocs.yml) by setting the `dev_addr` option.
28+
29+
## Publishing
30+
31+
The documentation is published automatically for all changes in master and for every GitHub release.
32+
33+
See [gh-pages.yml](../.github/workflows/gh-pages.yml) workflow configuration for more details.

mkdocs/src/doc/docs/community/plugins-list.md

Lines changed: 0 additions & 160 deletions
This file was deleted.

mkdocs/src/doc/docs/developer_guide/architecture/extension_points/core_extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,5 +147,5 @@ and `CommonmarkRenderer`.
147147
`PostAction` is useful for when you want to run some actions after the documentation has been generated - for instance
148148
if you want to move some files around.
149149

150-
[Versioning plugin](../../../user_guide/plugins/versioning-plugin.md) utilizes `PostAction` in order to move
150+
[Versioning plugin](https://github.com/Kotlin/dokka/tree/master/plugins/versioning) utilizes `PostAction` in order to move
151151
generated documentation to versioned folders.

mkdocs/src/doc/docs/developer_guide/plugin-development/introduction.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Introduction to plugin development
22

3+
Dokka was built from the ground up to be easily extensible and highly customizable, which allows the community to
4+
implement plugins for missing or very specific features that are not provided out of the box.
5+
6+
Dokka plugins range anywhere from supporting other programming language sources to exotic output formats. You can add
7+
support for your own KDoc tags or annotations, teach Dokka how to render different DSLs that are found in KDoc
8+
descriptions, visually redesign Dokka's pages to be seamlessly integrated into your company's website, integrate
9+
it with other tools and so much more.
10+
311
In order to have an easier time developing plugins, it's a good idea to go through
412
[Dokka's internals](../architecture/architecture_overview.md) first to learn more about its
513
[data model](../architecture/data_model/documentables.md) and
@@ -51,7 +59,8 @@ versions of Dokka.
5159
You can follow the [sample plugin tutorial](sample-plugin-tutorial.md) which covers creation of a simple plugin: hide members
5260
annotated with your own `@Internal` annotation, that is exclude these members from generated documentation.
5361

54-
Fore more practical examples, have a look at sources of [community plugins](../../community/plugins-list.md).
62+
Fore more practical examples, have a look at sources of
63+
[community plugins](https://kotlinlang.org/docs/dokka-plugins.html#notable-plugins).
5564

5665
## Help
5766

mkdocs/src/doc/docs/faq.md

Lines changed: 0 additions & 2 deletions
This file was deleted.
-31.1 KB
Binary file not shown.
-89.6 KB
Binary file not shown.

mkdocs/src/doc/docs/index.md

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,9 @@
11
# Dokka
22

3-
`Dokka` is an API documentation engine for `Kotlin` that performs the same function as the `Javadoc` tool for `Java`,
4-
but it's modern and highly pluggable.
3+
Dokka is an API documentation engine for Kotlin.
54

6-
Just like `Kotlin` itself, `Dokka` supports mixed-language projects (`Kotlin`/`Java`). It understands
7-
[KDoc comments](https://kotlinlang.org/docs/reference/kotlin-doc.html) in `Kotlin` source files as well
8-
as [Javadoc comments](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format) in `Java`
9-
files, and can generate documentation in multiple formats including its own `HTML` format, Java's `Javadoc` lookalike
10-
and `Markdown`.
5+
If you want to learn how to use Dokka, see
6+
[documentation on kotlinlang.org](https://kotlinlang.org/docs/dokka-introduction.html).
117

12-
Some libraries that use `Dokka` for API reference docs:
13-
14-
* [kotlinx.coroutines](https://kotlinlang.org/api/kotlinx.coroutines/)
15-
* [kotlinx.serialization](https://kotlinlang.org/api/kotlinx.serialization/)
16-
* [Ktor](https://api.ktor.io/)
17-
* [Spring Framework](https://docs.spring.io/spring-framework/docs/current/kdoc-api/)
18-
19-
___
20-
21-
`Dokka` provides support for the following build systems:
22-
23-
* [Gradle](user_guide/applying/gradle.md) (preferred)
24-
* [Maven](user_guide/applying/maven.md)
25-
* [Command line](user_guide/applying/cli.md)
26-
27-
___
28-
29-
`Dokka` is also very pluggable and comes with convenient plugin and extension point API.
30-
31-
You can write a plugin to support [mermaid.js](community/plugins-list.md#mermaid) diagrams,
32-
[mathjax](community/plugins-list.md#mathjax) formulas or even write custom processing of your own tags and annotations.
33-
34-
For more info, see:
35-
36-
* [Sample plugin tutorial](developer_guide/plugin-development/sample-plugin-tutorial.md)
37-
* [Community plugins](community/plugins-list.md)
38-
* [Developer guides](developer_guide/introduction.md)
8+
If you want to learn more about Dokka's internals and/or how to write Dokka plugins,
9+
see [Developer guides](developer_guide/introduction.md).

0 commit comments

Comments
 (0)