diff --git a/.github/workflows/dox.yml b/.github/workflows/dox.yml
index c2febcc..f600131 100644
--- a/.github/workflows/dox.yml
+++ b/.github/workflows/dox.yml
@@ -52,35 +52,32 @@ jobs:
repository: Smithsonian/smax-clib
path: smax-clib
-# - name: Check out xchange dependency
-# uses: actions/checkout@v4
-# with:
-# repository: Smithsonian/xchange
-# path: xchange
+ - name: Check out xchange dependency
+ uses: actions/checkout@v4
+ with:
+ repository: Smithsonian/xchange
+ path: xchange
-# - name: Check out RedisX dependency
-# uses: actions/checkout@v4
-# with:
-# repository: Smithsonian/redisx
-# path: redisx
+ - name: Check out RedisX dependency
+ uses: actions/checkout@v4
+ with:
+ repository: Smithsonian/redisx
+ path: redisx
-# - name: Generate docs
-# run: make -C xchange local-dox
-
-# - name: Generate docs
-# run: make -C redisx local-dox
+ - name: Generate docs
+ run: make -C xchange local-dox
- name: Generate docs
- run: make -C smax-clib local-dox
+ run: make -C redisx local-dox
-# - name: Generate headless README for smax-clib
-# run: make -C smax-clib README-orig.md
-#
-# - name: Generate smax-clib apidocs
-# uses: mattnotmitt/doxygen-action@v1.9.8
-# with:
-# additional-packages: font-roboto
-# working-directory: ./smax-clib
+ - name: Generate headless README for smax-clib
+ run: make -C smax-clib README-smax.md
+
+ - name: Generate smax-clib apidocs
+ uses: mattnotmitt/doxygen-action@v1.9.8
+ with:
+ additional-packages: font-roboto
+ working-directory: ./smax-clib
- name: Checkout gh-pages
uses: actions/checkout@v4
@@ -95,7 +92,7 @@ jobs:
run: |
echo '' > site/doc/README.md
echo '
' >> site/doc/README.md
- cat smax-clib/README-orig.md >> site/doc/README.md
+ cat smax-clib/README-smax.md >> site/doc/README.md
- name: Copy CHANGELOG
run: cp smax-clib/CHANGELOG.md site/doc/
diff --git a/.gitignore b/.gitignore
index 17a57a4..8c46e7f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,6 +8,7 @@
*~
*.swp
README-orig.md
+README-smax.md
TODO
xchange/**
redisx/**
diff --git a/Doxyfile b/Doxyfile
index 5c8a63d..f20df8c 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -1173,7 +1173,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
-USE_MDFILE_AS_MAINPAGE = README-orig.md
+USE_MDFILE_AS_MAINPAGE = README-smax.md
# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
diff --git a/Makefile b/Makefile
index 1ae9a51..dca67b9 100644
--- a/Makefile
+++ b/Makefile
@@ -52,7 +52,7 @@ test:
# Remove intermediates
.PHONY: clean
clean:
- rm -f $(OBJECTS) README-orig.md gmon.out
+ rm -f $(OBJECTS) README-smax.md gmon.out
# Remove all generated files
.PHONY: distclean
@@ -79,10 +79,10 @@ $(LIB)/libsmax.so.$(SO_VERSION): $(SOURCES)
# Static library
$(LIB)/libsmax.a: $(OBJECTS) | $(LIB) Makefile
-README-orig.md: README.md
+README-smax.md: README.md
LINE=`sed -n '/\# /{=;q;}' $<` && tail -n +$$((LINE+2)) $< > $@
-dox: README-orig.md
+dox: README-smax.md
.INTERMEDIATE: Doxyfile.local
Doxyfile.local: Doxyfile Makefile
@@ -92,7 +92,7 @@ Doxyfile.local: Doxyfile Makefile
# Local documentation without specialized headers. The resulting HTML documents do not have
# Google Search or Analytics tracking info.
.PHONY: local-dox
-local-dox: README-orig.md Doxyfile.local
+local-dox: README-smax.md Doxyfile.local
doxygen Doxyfile.local
# Built-in help screen for `make help`