docs/rst: Use pandoc to render ReStructuredText

Sphinx uses ReStructuredText as its markup format.  Although missing the
project wide integration, individual *.rst files can be rendered by pandoc to
suppliement our existing ad-hoc documentation.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
This commit is contained in:
Andrew Cooper committed 2019-03-22 13:48:02 +00:00
1 parent 530f9aabab
commit c16d22fce8
1 file changed
+9 -1
+9 -1
View File
@@ -11,6 +11,8 @@ MAN_SECTIONS := 1 5 7 8
# Documentation sources to build
MAN-SRC-y := $(sort $(basename $(wildcard man/*.pod man/*.pandoc)))
RST-SRC-y := $(sort $(filter-out %index.rst,$(shell find * -type f -name '*.rst' -print)))
TXTSRC-y := $(sort $(shell find misc -name '*.txt' -print))
PANDOCSRC-y := $(sort $(shell find designs/ features/ misc/ process/ specs/ -name '*.pandoc' -print))
@@ -22,13 +24,16 @@ $(foreach i,$(MAN_SECTIONS), \
DOC_HTML := html/SUPPORT.html \
$(patsubst %.pandoc,html/%.html,$(PANDOCSRC-y)) \
$(patsubst %.rst,html/%.html,$(RST-SRC-y)) \
$(patsubst %,html/%.html,$(MAN-SRC-y)) \
$(patsubst %.txt,html/%.txt,$(TXTSRC-y)) \
$(patsubst %,html/hypercall/%/index.html,$(DOC_ARCHES))
DOC_TXT := $(patsubst %.txt,txt/%.txt,$(TXTSRC-y)) \
$(patsubst %.pandoc,txt/%.txt,$(PANDOCSRC-y)) \
$(patsubst %.rst,txt/%.txt,$(RST-SRC-y)) \
$(patsubst %,txt/%.txt,$(MAN-SRC-y))
DOC_PDF := $(patsubst %.pandoc,pdf/%.pdf,$(PANDOCSRC-y))
DOC_PDF := $(patsubst %.pandoc,pdf/%.pdf,$(PANDOCSRC-y)) \
$(patsubst %.rst,pdf/%.pdf,$(RST-SRC-y))
# Top level build targets
.PHONY: all
@@ -224,8 +229,11 @@ define GENERATE_PANDOC_RULE
$(call GENERATE_PANDOC_RULE_RAW,$(1)/%.$(1),%.$(2))
endef
$(eval $(call GENERATE_PANDOC_RULE,pdf,pandoc)) # pdf/%.pdf: %.pandoc
$(eval $(call GENERATE_PANDOC_RULE,pdf,rst)) # pdf/%.pdf: %.rst
$(eval $(call GENERATE_PANDOC_RULE,txt,pandoc)) # txt/%.txt: %.pandoc
$(eval $(call GENERATE_PANDOC_RULE,txt,rst)) # txt/%.txt: %.rst
$(eval $(call GENERATE_PANDOC_RULE,html,pandoc)) # html/%.html: %.pandoc
$(eval $(call GENERATE_PANDOC_RULE,html,rst)) # html/%.html: %.rst
$(eval $(call GENERATE_PANDOC_RULE_RAW,html/SUPPORT.html,$(XEN_ROOT)/SUPPORT.md))
Reference in new issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.