Skip to content

Commit db95a44

Browse files
authored
Improve doc (#74)
* use antora for documentation Signed-off-by: Jorge Aguilera <[email protected]> * use antora for documentation Signed-off-by: Jorge Aguilera <[email protected]> * use antora for documentation Signed-off-by: Jorge Aguilera <[email protected]> --------- Signed-off-by: Jorge Aguilera <[email protected]>
1 parent 88474c9 commit db95a44

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+420
-27
lines changed

.github/workflows/ghpages.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ jobs:
3131
distribution: 'temurin'
3232
architecture: x64
3333
- name: Generate
34-
run: ./gradlew asciidoctor
34+
run: ./gradlew antora
3535
- name: Upload artifact
3636
uses: actions/upload-pages-artifact@v2
3737
with:
38-
path: ./build/docs/asciidoc
38+
path: ./build/site
3939

4040
publish-ghpages:
4141
needs: build

antora-playbook.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
site:
2+
title: Nextflow Nomad executor
3+
start_page: main:ROOT:index.adoc
4+
content:
5+
sources:
6+
- url: .
7+
start_path: ./src/docs/antora
8+
edit_url: false
9+
branches: HEAD
10+
11+
ui:
12+
bundle:
13+
url: ./src/docs/antora/ui
14+
snapshot: true

build.gradle

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ buildscript {
55
}
66

77
plugins {
8-
id("org.asciidoctor.jvm.convert") version "3.3.2"
8+
id 'org.antora' version '1.0.0'
99
}
1010

1111
repositories {
@@ -22,7 +22,18 @@ nextflowPlugin{
2222
]
2323
}
2424

25-
asciidoctor{
26-
baseDir 'src/docs/asciidoc'
27-
attributes revnumber : { project.version.toString() }
25+
node {
26+
version = 'latest'
27+
}
28+
29+
antora {
30+
version = '3.0.3'
31+
options = [
32+
clean: true,
33+
fetch: true,
34+
stacktrace: true,
35+
attributes: [product: 'Nf-Nomad Plugin']
36+
]
37+
environment = [:]
38+
packages = [:]
2839
}

src/docs/antora/antora.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: main
2+
version: final
3+
title: nf-nomad
4+
nav:
5+
- modules/ROOT/nav.adoc

src/docs/antora/modules/ROOT/nav.adoc

Lines changed: 9 additions & 0 deletions
Lines changed: 25 additions & 0 deletions

src/docs/asciidoc/parts/intro.adoc renamed to src/docs/antora/modules/ROOT/pages/index.adoc

Lines changed: 2 additions & 1 deletion

src/docs/asciidoc/parts/usage.adoc renamed to src/docs/antora/modules/ROOT/pages/usage.adoc

Lines changed: 2 additions & 2 deletions

src/docs/antora/ui/css/site.css

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)