1
0
Fork 0
mirror of https://codeberg.org/Mo8it/AdvLabDB.git synced 2024-12-20 23:41:20 +00:00
AdvLabDB/docs/README.adoc

15 lines
585 B
Text
Raw Normal View History

2022-01-16 15:13:48 +00:00
= Updating documentation
After changing the documentation files with the `.adoc` extension in this directory, the script `update_docs.sh` has to be run to update the related html files in the directory `advlabdb/advlabdb/templates/docs`.
2022-02-13 19:05:29 +00:00
IMPORTANT: You have to `cd` into the `advlabdb/docs` directory where the script, this README and the documentation files with the `.adoc` extension are located before running the script!
2022-01-16 15:13:48 +00:00
IMPORTANT: The packages `fd` (`find` alternative) and `asciidoctor` have to be installed!
Run the script with:
[source,bash]
----
bash update_docs.sh
----