From e5b371ba3faec65571ba4dc2dc31302907ce2c9a Mon Sep 17 00:00:00 2001 From: Peter Hartmann Date: Mon, 25 Nov 2024 17:09:59 +0100 Subject: [PATCH] update instructions --- doc/generate-website.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/doc/generate-website.md b/doc/generate-website.md index b9c5c4ce..516118b2 100644 --- a/doc/generate-website.md +++ b/doc/generate-website.md @@ -30,6 +30,33 @@ doxygen ``` This will generate the documentation into the `api` folder. +### Generating specific header and footer files for doxygen + +*This needs to be done only when the doxygen version changes.* + +``` +cd ~/dev/qskinny/doc +doxygen -w html api/header.html api/footer.html +``` + +Now open `api/header.html` and copy the code block starting with +the comment `` into the new header file. + +*Also*, change the `` tag to load the WASM code at +startup: + +``` + +``` + +### Using a different stylesheet for doxygen +``` +git clone git clone git@github.com:jothepro/doxygen-awesome-css.git +cd doxygen-awesome-css +git checkout v2.3.4 +cp doxygen-awesome.css ~/dev/qskinny/doc/ +``` + ### Testing and building the website locally First copy the generated files from above to the website repo: @@ -62,7 +89,7 @@ new version of the homepage: cp -r _site/* ~/dev/qskinny.github.io/ cd ~/dev/qskinny.github.io/ git commit -a -m "new version" # you might want to add new files -gith push +git push ``` That's it, the new website is now published at https://qskinny.github.io/ .