docs: add configuration files for antora

esynr3z · May 25, 2024 · c41c637 · c41c637
1 parent 66a7135
commit c41c637
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-.vscode
+.vscode
+build
diff --git a/antora-playbook.yml b/antora-playbook.yml
@@ -0,0 +1,15 @@
+site:
+  title: SystemVerilog JSON Package Documentation
+  start_page: json_pkg::overview.adoc
+content:
+  sources:
+    - url: .
+      start_path: docs
+asciidoc:
+  attributes:
+    toc: 'true'
+    toclevels: 3
+ui:
+  bundle:
+    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
+    snapshot: true
diff --git a/docs/antora.yml b/docs/antora.yml
@@ -0,0 +1,10 @@
+name: json_pkg
+title: JSON Package
+version: true
+start_page: overview.adoc
+asciidoc:
+  attributes:
+    source-language: asciidoc@
+    table-caption: false
+nav:
+- modules/ROOT/nav.adoc
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc
@@ -0,0 +1,5 @@
+* xref:overview.adoc[]
+* xref:user.adoc[]
+* xref:classref.adoc[]
+* xref:development.adoc[]
+* xref:changelog.adoc[]
diff --git a/docs/modules/ROOT/pages/changelog.adoc b/docs/modules/ROOT/pages/changelog.adoc
@@ -0,0 +1,3 @@
+= Changelog
+
+TODO
diff --git a/docs/modules/ROOT/pages/classref.adoc b/docs/modules/ROOT/pages/classref.adoc
@@ -0,0 +1,3 @@
+= Class reference
+
+TODO
diff --git a/docs/modules/ROOT/pages/development.adoc b/docs/modules/ROOT/pages/development.adoc
@@ -0,0 +1,3 @@
+= Developer guide
+
+TODO
diff --git a/docs/modules/ROOT/pages/overview.adoc b/docs/modules/ROOT/pages/overview.adoc
@@ -0,0 +1,3 @@
+= Overview
+
+TODO
diff --git a/docs/modules/ROOT/pages/user.adoc b/docs/modules/ROOT/pages/user.adoc
@@ -0,0 +1,3 @@
+= User guide
+
+TODO