root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Generate manpages in markdown in addition to HTML 

[Why]
This file format can be used directly by Docusaurus. The HTML version
could work too, but generated files require patching to work correctly.
This commit is contained in:
Jean-Sébastien Pédron 2023-12-18 12:16:04 +01:00
parent 6907664433
commit bc52edd2c5
No known key found for this signature in database
GPG Key ID: 39E99761A5FD94CC
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
deps/rabbit/Makefile vendored
View File

@ -153,6 +153,7 @@ endef
DOCS_DIR = docs DOCS_DIR = docs
MANPAGES = $(wildcard $(DOCS_DIR)/*.[0-9]) MANPAGES = $(wildcard $(DOCS_DIR)/*.[0-9])
WEB_MANPAGES = $(patsubst %,%.html,$(MANPAGES)) WEB_MANPAGES = $(patsubst %,%.html,$(MANPAGES))
MD_MANPAGES = $(patsubst %,%.md,$(MANPAGES))
DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-test.mk DEP_EARLY_PLUGINS = rabbit_common/mk/rabbitmq-early-test.mk
DEP_PLUGINS = rabbit_common/mk/rabbitmq-build.mk \ DEP_PLUGINS = rabbit_common/mk/rabbitmq-build.mk \
@ -271,7 +272,7 @@ docs:: manpages web-manpages
manpages: $(MANPAGES) manpages: $(MANPAGES)
@: @:
web-manpages: $(WEB_MANPAGES) web-manpages: $(WEB_MANPAGES) $(MD_MANPAGES)
@: @:
# We use mandoc(1) to convert manpages to HTML plus an awk script which # We use mandoc(1) to convert manpages to HTML plus an awk script which
@ -299,7 +300,12 @@ web-manpages: $(WEB_MANPAGES)
} } \ } } \
' > "$@" ' > "$@"
%.md: %
$(gen_verbose) mandoc -T markdown -O 'fragment,man=%N.%S.md' "$<" | \
sed -E -e 's/\{/\&lcub;/g' \
> "$@"
distclean:: distclean-manpages distclean:: distclean-manpages
distclean-manpages:: distclean-manpages::
$(gen_verbose) rm -f $(WEB_MANPAGES) $(gen_verbose) rm -f $(WEB_MANPAGES) $(MD_MANPAGES)