summaryrefslogtreecommitdiff
path: root/.github/workflows/docs.yml
diff options
context:
space:
mode:
Diffstat (limited to '.github/workflows/docs.yml')
-rw-r--r--.github/workflows/docs.yml31
1 files changed, 12 insertions, 19 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 854f769..8a9f7bc 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -23,29 +23,22 @@ jobs:
sudo apt-get update
sudo apt-get install -y doxygen graphviz
- - name: Clone Doxygen Awesome Theme
- run: |
- git clone https://github.com/jothepro/doxygen-awesome-css.git doxygen-awesome
- mkdir -p docs/theme
- cp doxygen-awesome/doxygen-awesome.css docs/theme/
- cp doxygen-awesome/doxygen-awesome-dark-mode.css docs/theme/
- cp doxygen-awesome/doxygen-awesome-darkmode-toggle.js docs/theme/
-
- name: Create and Configure Doxyfile
run: |
- doxygen -g Doxyfile
+ doxygen -g
- # Customize Doxyfile settings
- sed -i 's/^PROJECT_NAME *=.*$/PROJECT_NAME = "fbgl"/' Doxyfile
- sed -i 's/^PROJECT_NUMBER *=.*$/PROJECT_NUMBER = 0.1.0/' Doxyfile
- sed -i 's/^OUTPUT_DIRECTORY *=.*$/OUTPUT_DIRECTORY = docs/' Doxyfile
- sed -i 's/^INPUT *=.*$/INPUT = fbgl.h README.md/' Doxyfile
- sed -i 's/^HTML_OUTPUT *=.*$/HTML_OUTPUT = html/' Doxyfile
- sed -i 's/^USE_MDFILE_AS_MAINPAGE *=.*$/USE_MDFILE_AS_MAINPAGE = README.md/' Doxyfile
+ # Append required settings to Doxyfile
+ echo "PROJECT_NAME = fbgl" >> Doxyfile
+ echo "PROJECT_NUMBER = 0.1.0" >> Doxyfile
+ echo "OUTPUT_DIRECTORY = docs" >> Doxyfile
+ echo "INPUT = fbgl.h README.md" >> Doxyfile
+ echo "HTML_OUTPUT = html" >> Doxyfile
+ echo "USE_MDFILE_AS_MAINPAGE = README.md" >> Doxyfile
+ echo "GENERATE_TREEVIEW = YES" >> Doxyfile
- # Configure Doxygen Awesome theme
- echo 'HTML_EXTRA_STYLESHEET = docs/theme/doxygen-awesome.css docs/theme/doxygen-awesome-dark-mode.css' >> Doxyfile
- echo 'HTML_HEADER = docs/theme/doxygen-awesome-darkmode-toggle.js' >> Doxyfile
+ # Use Doxygen Awesome Theme via CDN
+ echo "HTML_EXTRA_STYLESHEET = https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@v2.3.4/doxygen-awesome.css" >> Doxyfile
+ echo "HTML_EXTRA_FILES = https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@v2.3.4/doxygen-awesome-darkmode-toggle.js" >> Doxyfile
- name: Generate Documentation
run: doxygen Doxyfile