Antora

[aremazeilles]

WORK IN PROGRESS

Folder adjustment to generate a website based on the documentation. The output result is deployed to a eurobench repository.

The generated website is then accessible at the adress https://eurobench.github.io/

The tool for generating the static website is antora, which is I think the readthedocs alternative for asciidoc projects. I had to adjust the repo structure to comply with the expectation of antora, as described here.

Then, apart from the doc repo, two additional components that were added:

• a UI theme, which is a slight adjustment of the default antora model
• a playbook, which contains the configuration information to run antora

All the process happens then through the CI action, which:

• gets the playbook from the remote repository
• launch antora using a dedicated action
• upload as artifact the built site (for debugging purposes)
• deploy the content to a Github pages.

I would still have some adjustments to do, but I wanted to share it with you.

Any thought?

[aremazeilles]

Si I am likely to work on this today, and do the merge. Have not time to address the extension yet, but I think it is a good first step although