Skip to content

Commit

Permalink
Rename README-orig.md -> README-redisx.md to avoid name conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Sep 14, 2024
1 parent 1bfab2e commit 76530b6
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 15 deletions.
17 changes: 7 additions & 10 deletions .github/workflows/dox.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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/[email protected]
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/[email protected]
Expand All @@ -85,7 +82,7 @@ jobs:
run: |
echo '<img src="/redisx/resources/CfA-logo.png" alt="CfA logo" width="400" height="67" align="right">' > site/doc/README.md
echo '<br clear="all">' >> 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/
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@
*~
*.swp
README-orig.md
README-redisx.md
TODO
xchange/**
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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`
Expand Down

0 comments on commit 76530b6

Please sign in to comment.