From e8d90e7c71c9faf526aa8fa711f77c14eb8f0424 Mon Sep 17 00:00:00 2001 From: sergeych Date: Sun, 25 Aug 2024 02:28:11 +0200 Subject: [PATCH] +autodocs --- .gitignore | 3 --- README.md | 9 ++++++++- bin/pubdocs | 4 ++++ build.gradle.kts | 14 +++++++++++++- 4 files changed, 25 insertions(+), 5 deletions(-) create mode 100755 bin/pubdocs diff --git a/.gitignore b/.gitignore index bc1c5cd..5256e90 100644 --- a/.gitignore +++ b/.gitignore @@ -24,9 +24,6 @@ out/ .settings .springBeans .sts4-cache -bin/ -!**/src/main/**/bin/ -!**/src/test/**/bin/ ### NetBeans ### /nbproject/private/ diff --git a/README.md b/README.md index ad2795f..603f21d 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,18 @@ are incompatible with older. Sorry for inconvenience. # Usage ```kotlin +repositories { + maven("https://gitea.sergeych.net/api/packages/SergeychWorks/maven") +} dependencies { - maven("https://gitea.sergeych.net/api/packages/SergeychWorks/maven") + import("net.sergeych:crypto2:0.5.4") } ``` +# Documentation + +Please see the current documentation [here](https://code.sergeych.net/docs/crypto2/). + # Supported platforms: ## Javascript diff --git a/bin/pubdocs b/bin/pubdocs new file mode 100755 index 0000000..a2c5957 --- /dev/null +++ b/bin/pubdocs @@ -0,0 +1,4 @@ +#!/bin/bash +set -e +./gradlew dokkaHtml +rsync -avz ./build/dokka/* code.sergeych.net:/bigstore/sergeych_pub/code/docs/crypto2 diff --git a/build.gradle.kts b/build.gradle.kts index ae0b19c..c28e84d 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,11 +1,12 @@ plugins { kotlin("multiplatform") version "2.0.20" id("org.jetbrains.kotlin.plugin.serialization") version "2.0.20" + id("org.jetbrains.dokka") version "1.9.20" `maven-publish` } group = "net.sergeych" -version = "0.5.3" +version = "0.5.4" repositories { mavenCentral() @@ -93,3 +94,14 @@ publishing { } } } + +tasks.dokkaHtml.configure { + outputDirectory.set(buildDir.resolve("dokka")) + dokkaSourceSets { +// configureEach { +// includes.from("docs/bipack.md") +// } + } +} + +