From c41c63763e2d3443078c1e2df2747efc04304b7c Mon Sep 17 00:00:00 2001 From: esynr3z Date: Sat, 25 May 2024 13:00:37 +0300 Subject: [PATCH] docs: add configuration files for antora --- .gitignore | 3 ++- antora-playbook.yml | 15 +++++++++++++++ docs/antora.yml | 10 ++++++++++ docs/modules/ROOT/nav.adoc | 5 +++++ docs/modules/ROOT/pages/changelog.adoc | 3 +++ docs/modules/ROOT/pages/classref.adoc | 3 +++ docs/modules/ROOT/pages/development.adoc | 3 +++ docs/modules/ROOT/pages/overview.adoc | 3 +++ docs/modules/ROOT/pages/user.adoc | 3 +++ 9 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 antora-playbook.yml create mode 100644 docs/antora.yml create mode 100644 docs/modules/ROOT/nav.adoc create mode 100644 docs/modules/ROOT/pages/changelog.adoc create mode 100644 docs/modules/ROOT/pages/classref.adoc create mode 100644 docs/modules/ROOT/pages/development.adoc create mode 100644 docs/modules/ROOT/pages/overview.adoc create mode 100644 docs/modules/ROOT/pages/user.adoc diff --git a/.gitignore b/.gitignore index 600d2d3..6a8bc10 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -.vscode \ No newline at end of file +.vscode +build \ No newline at end of file diff --git a/antora-playbook.yml b/antora-playbook.yml new file mode 100644 index 0000000..c7d5463 --- /dev/null +++ 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 new file mode 100644 index 0000000..a4ffc3c --- /dev/null +++ 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 new file mode 100644 index 0000000..f6d1fb2 --- /dev/null +++ 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 new file mode 100644 index 0000000..ff537f3 --- /dev/null +++ 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 new file mode 100644 index 0000000..df416ac --- /dev/null +++ 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 new file mode 100644 index 0000000..8785b5a --- /dev/null +++ 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 new file mode 100644 index 0000000..d675982 --- /dev/null +++ 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 new file mode 100644 index 0000000..90e4d3f --- /dev/null +++ b/docs/modules/ROOT/pages/user.adoc @@ -0,0 +1,3 @@ += User guide + +TODO