Skip to content

Commit

Permalink
Make two md man pages, one for the wiki and one for the actual man page
Browse files Browse the repository at this point in the history
  • Loading branch information
xchang1 committed Dec 19, 2024
1 parent ad1b14e commit ccf4277
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -546,11 +546,15 @@ docs: $(SRC_DIR)/*.cpp $(SRC_DIR)/*.hpp $(ALGORITHMS_SRC_DIR)/*.cpp $(ALGORITHMS

man: doc/wiki/vg-manpage.md doc/man/vg.1

doc/wiki/vg-manpage.md: $(BIN_DIR)/$(EXE) doc/vgmanmd.desc.md doc/vgmanmd.py
./doc/vgmanmd.py > $@.tmp && mv $@.tmp $@
#The manpage markdown has an extra line needed for the actual manpage format
doc/man/vg-manpage.md: $(BIN_DIR)/$(EXE) doc/vgmanmd.desc.md doc/vgmanmd.py
mkdir -p doc/man && ./doc/vgmanmd.py > $@.tmp && mv $@.tmp $@

doc/man/vg.1: doc/wiki/vg-manpage.md
mkdir -p doc/man && pandoc --standalone --to man $< -o $@
doc/wiki/vg-manpage.md: doc/man/vg-manpage.md
sed 1d doc/man/vg-manpage.md > $@

doc/man/vg.1: doc/man/vg-manpage.md
pandoc --standalone --to man $< -o $@

# Hack to use gshuf or shuf as appropriate to the platform when testing
$(BIN_DIR)/shuf:
Expand Down

1 comment on commit ccf4277

@adamnovak
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vg CI tests complete for branch docmd. View the full report here.

16 tests passed, 0 tests failed and 0 tests skipped in 17350 seconds

Please sign in to comment.