Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .github/workflows/nightlydeploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,15 @@ jobs:
uses: gradle/actions/setup-gradle@v6

- name: Generated Stubs, Documentation and Assemble
run: ./gradlew --parallel :keyext.api.doc:run :dokkaGeneratePublicationHtml assemble
run: ./gradlew --parallel :keyext.api.doc:run
- run: ./gradlew --parallel :dokkaGeneratePublicationHtml assemble

- run: mv -v build/dokka/html/ out/dokka

- run: mv out/* build/dokka/html/
- name: "Upload GitHub Pages artifact"
uses: actions/upload-pages-artifact@v5
with:
path: build/dokka/html
path: out/
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,16 @@ body {
}

ul {
padding-left: 2ex;
}

ul.segments > li abbr {
font-size: 120%;
font-weight: bold;
}

li {
list-style: disc;
}
}

Expand Down
39 changes: 39 additions & 0 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "Index"
---

# key-rpc
The JSON-RPC interface for the KeY theorem prover

# Module sample
Sample examples for Dokka Mermaid plugin.

```mermaid
pie title NETFLIX
"Time spent looking for movie" : 90
"Time spent watching it" : 10
```

# Package com.glureau.dokkamermaid.sample

Package documentation can have its own mermaid diagrams.

```mermaid
mindmap
root((mindmap))
Origins
Long history
::icon(fa fa-book)
Popularisation
British popular psychology author Tony Buzan
Research
On effectiveness<br/>and features
On Automatic creation
Uses
Creative techniques
Strategic planning
Argument mapping
Tools
Pen and paper
Mermaid
```
32 changes: 0 additions & 32 deletions gradle/index.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,3 @@
# key-rpc
The JSON-RPC interface for the KeY theorem prover

# Module sample
Sample examples for Dokka Mermaid plugin.

```mermaid
pie title NETFLIX
"Time spent looking for movie" : 90
"Time spent watching it" : 10
```

# Package com.glureau.dokkamermaid.sample

Package documentation can have its own mermaid diagrams.

```mermaid
mindmap
root((mindmap))
Origins
Long history
::icon(fa fa-book)
Popularisation
British popular psychology author Tony Buzan
Research
On effectiveness<br/>and features
On Automatic creation
Uses
Creative techniques
Strategic planning
Argument mapping
Tools
Pen and paper
Mermaid
```
3 changes: 3 additions & 0 deletions gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ therapi = "0.15.0"
kotlin-gradle-plugin = "2.4.0"
dokka = "2.2.0"
spotless = "8.7.0"
kotlinx-coroutines = "1.10.1"

[libraries]
kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin-gradle-plugin" }
Expand All @@ -28,3 +29,5 @@ guava = { module = "com.google.guava:guava", version.ref = "guava" }
therapi-runtime-javadoc-scribe = { module = "com.github.therapi:therapi-runtime-javadoc-scribe", version.ref = "therapi" }
therapi-runtime-javadoc = { module = "com.github.therapi:therapi-runtime-javadoc", version.ref = "therapi" }
clickt = { module = "com.github.ajalt.clikt:clikt", version = "5.1.0" }
kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines" }
kotlinx-coroutines-js = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core-js", version.ref = "kotlinx-coroutines" }

This file was deleted.

Loading