1
0
Fork 0
mirror of https://codeberg.org/Mo8it/AdvLabDB.git synced 2024-12-22 23:51:03 +00:00
AdvLabDB/docs/user_docs/README.adoc
2022-05-08 17:29:45 +02:00

14 lines
585 B
Text

= 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`.
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!
IMPORTANT: The packages `fd` (`find` alternative) and `asciidoctor` have to be installed!
Run the script with:
[source,bash]
----
bash update_docs.sh
----