Skip to content

Commit 8a10d63

Browse files
committed
Fix Doxygen workflow: add Graphviz, clean output, improve Pages deployment
1 parent a45f009 commit 8a10d63

File tree

3 files changed

+28
-7
lines changed

3 files changed

+28
-7
lines changed

.github/workflows/documentation.yml

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@ jobs:
3939
- name: Set up Docker Buildx
4040
uses: docker/setup-buildx-action@v2
4141

42+
- name: Clean previous artifacts
43+
run: |
44+
rm -rf generated
45+
docker system prune -f
46+
4247
- name: Build documentation files
4348
uses: docker/build-push-action@v5
4449
with:
@@ -49,17 +54,24 @@ jobs:
4954

5055
- name: Get generated files
5156
run: |
52-
mkdir generated
53-
docker create --name doxygen-generated-files doxygen-generated-files
54-
docker cp doxygen-generated-files:/docs/html generated
57+
mkdir -p generated
58+
docker create --name doxygen-container doxygen-generated-files
59+
docker cp doxygen-container:/docs/html generated/
60+
docker rm doxygen-container
61+
62+
- name: Check generated files
63+
run: |
64+
echo "Checking generated files size and content..."
65+
du -sh generated/
66+
find generated/ -type l -ls || echo "No symlinks found"
67+
ls -la generated/html/
5568
5669
- name: Setup Pages
5770
uses: actions/configure-pages@v3
5871

5972
- name: Upload artifact
60-
uses: actions/upload-artifact@v4
73+
uses: actions/upload-artifact@v3
6174
with:
62-
name: 'github-pages'
6375
path: 'generated/html'
6476

6577
- name: Deploy to GitHub Pages

docs/Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ PROJECT_ICON =
7474
# entered, it will be relative to the location where Doxygen was started. If
7575
# left blank the current directory will be used.
7676

77-
OUTPUT_DIRECTORY = /docs
77+
OUTPUT_DIRECTORY = .
7878

7979
# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
8080
# sub-directories (in 2 levels) under the output directory of each output format
@@ -2966,7 +2966,7 @@ MAX_DOT_GRAPH_DEPTH = 0
29662966
# The default value is: NO.
29672967
# This tag requires that the tag HAVE_DOT is set to YES.
29682968

2969-
DOT_MULTI_TARGETS = NO
2969+
DOT_MULTI_TARGETS = YES
29702970

29712971
# If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
29722972
# explaining the meaning of the various boxes and arrows in the dot generated

docs/doxygen-generator.dockerfile

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
FROM tracto/spark-doxygen-build-tools:latest
22

3+
# --------------------------------------------
4+
# Install Graphviz and clean old docs
5+
# --------------------------------------------
6+
RUN apt-get update && apt-get install -y graphviz && rm -rf /var/lib/apt/lists/*
7+
38
# --------------------------------------------
49
# Add code and custom documentation
510
# --------------------------------------------
@@ -12,6 +17,10 @@ ADD ./Source ./Source
1217
# Generate documentation
1318
# --------------------------------------------
1419
WORKDIR /docs
20+
21+
# Clean any existing documentation
22+
RUN rm -rf html latex
23+
1524
RUN mv $DOXYGEN_AWESOME_CSS/* .
1625
RUN mv /sources/docs/* .
1726
RUN doxygen Doxyfile

0 commit comments

Comments
 (0)