Skip to content

Commit

Permalink
chore: use philips-software/antora-site-action to generate documentat…
Browse files Browse the repository at this point in the history
…ion (#750)

* chore: user philips-software/antora-site-action to generate documentation

* Move playbook to documents folder

* Require lunr-extension

* Remove antora-site-generator-lunr from workflow

* Move document generation root to git archive root

* Fix supplemental_ui path

* Documentation contents fixes

* Pin released version of antora-site-action
  • Loading branch information
richardapeters authored Oct 24, 2024
1 parent ed39658 commit 01f56f6
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 16 deletions.
12 changes: 2 additions & 10 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,9 @@ jobs:
with:
fetch-depth: 0
persist-credentials: false
- run: npm i asciidoctor-kroki
- name: Build Antora Site
uses: philips-forks/antora-site-action@ef15f74e055960099ec1bf58f4f8148d1f07a0c2
- uses: philips-software/antora-site-action@3540c48165a9ac1620a2cb57f52cafb06f779aa8 # 1.1.0
with:
antora_playbook: antora-playbook-site.yml
antora_generator: "antora-site-generator-lunr"
antora_docsearch_enabled: "true"
- name: Store Antora Site
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
with:
Expand All @@ -48,13 +44,9 @@ jobs:
with:
fetch-depth: 0
persist-credentials: false
- run: npm i asciidoctor-kroki
- name: Build Antora Site
uses: philips-forks/antora-site-action@ef15f74e055960099ec1bf58f4f8148d1f07a0c2
- uses: philips-software/antora-site-action@3540c48165a9ac1620a2cb57f52cafb06f779aa8 # 1.1.0
with:
antora_playbook: antora-playbook-branch.yml
antora_generator: "antora-site-generator-lunr"
antora_docsearch_enabled: "true"
- name: Store Antora Site
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
with:
Expand Down
5 changes: 4 additions & 1 deletion antora-playbook-branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
supplemental_files: ./documents/supplemental-ui
supplemental_files: documents/supplemental-ui
antora:
extensions:
- require: "@antora/lunr-extension"
asciidoc:
attributes:
kroki-fetch-diagram: true
Expand Down
5 changes: 4 additions & 1 deletion antora-playbook-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
supplemental_files: ./documents/supplemental-ui
supplemental_files: documents/supplemental-ui
antora:
extensions:
- require: "@antora/lunr-extension"
asciidoc:
attributes:
kroki-fetch-diagram: true
Expand Down
6 changes: 3 additions & 3 deletions documents/modules/ROOT/pages/Echo.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ decoding the individual message.
All files should be ordered in the following manner:

1. Syntax
1. Imports (sorted)
1. Package
1. Everything else
2. Imports (sorted)
3. Package
4. Everything else

=== Naming

Expand Down
2 changes: 1 addition & 1 deletion documents/modules/ROOT/pages/Sesame.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -212,5 +212,5 @@ COBS -> Windowed : ReleaseWindow\n03 07 00

[source,protobuf]
----
include::SesameSecurity.proto[]
include::example$SesameSecurity.proto[]
----

0 comments on commit 01f56f6

Please sign in to comment.