diff --git a/.github/workflows/dox.yml b/.github/workflows/dox.yml
index 1fc4028..b42f89d 100644
--- a/.github/workflows/dox.yml
+++ b/.github/workflows/dox.yml
@@ -41,6 +41,9 @@ jobs:
runs-on: ubuntu-latest
steps:
+
+ - name: install doxygen
+ run: sudo apt-get install doxygen
- name: Checkout source
uses: actions/checkout@v4
@@ -54,17 +57,11 @@ jobs:
repository: Smithsonian/xchange
path: xchange
- - name: Generate headless README for xchange
- run: make -C xchange README-orig.md
-
- - name: Generate xchange apidocs
- uses: mattnotmitt/doxygen-action@v1.9.8
- with:
- additional-packages: font-roboto
- working-directory: ./xchange
+ - name: Generate docs
+ run: make -C xchange local-dox
- name: Generate headless README for RedisX
- run: make -C redisx README-orig.md
+ run: make -C redisx README-redisx.md
- name: Generate RedisX apidocs
uses: mattnotmitt/doxygen-action@v1.9.8
@@ -85,7 +82,7 @@ jobs:
run: |
echo '' > site/doc/README.md
echo '
' >> site/doc/README.md
- cat redisx/README-orig.md >> site/doc/README.md
+ cat redisx/README-redisx.md >> site/doc/README.md
- name: Copy CHANGELOG
run: cp redisx/CHANGELOG.md site/doc/
diff --git a/.gitignore b/.gitignore
index c405bdb..a640e8d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,5 +8,6 @@
*~
*.swp
README-orig.md
+README-redisx.md
TODO
xchange/**
diff --git a/Doxyfile b/Doxyfile
index 3d7d69c..a2515a5 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-redisx.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 53bd0be..f00ed02 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-redisx.md gmon.out
# Remove all generated files
.PHONY: distclean
@@ -79,10 +79,10 @@ $(LIB)/libredisx.so.$(SO_VERSION): $(SOURCES)
# Static library
$(LIB)/libredisx.a: $(OBJECTS) | $(LIB) Makefile
-README-orig.md: README.md
+README-redisx.md: README.md
LINE=`sed -n '/\# /{=;q;}' $<` && tail -n +$$((LINE+2)) $< > $@
-dox: README-orig.md
+dox: README-redisx.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-redisx.md Doxyfile.local
doxygen Doxyfile.local
# Built-in help screen for `make help`