1
0
Fork 0
mirror of https://codeberg.org/Mo8it/AdvLabDB.git synced 2024-09-19 18:31:16 +00:00
AdvLabDB/docs
2022-03-19 22:42:13 +01:00
..
admin.adoc Added docs structure 2022-01-13 02:25:31 +01:00
assistant.adoc Added docs structure 2022-01-13 02:25:31 +01:00
README.adoc Fix typos 2022-02-13 20:05:29 +01:00
update_docs.sh Harden shell scripts 2022-03-19 22:42:13 +01: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`.

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
----