githubmirror/xmlsec

docs/html/Makefile.am
90 строк3 KB
lsh123
Cleanup makefiles and scripts (#1123)
08 апр 2026, 01:32
08 апр 2026, 01:326bc973f
#
# make all 		: prints info message
# make docs		: generates the html files (if necessary tools are present) or prints error
#
NULL =

# Markdown source files for generated HTML pages (all *.md in docs/md/)
MD_SRCDIR     = $(top_srcdir)/docs/md
MD_BUILDDIR   = $(top_builddir)/docs/md
MD_SRC_FILES  = \
	$(wildcard $(MD_SRCDIR)/*.md) \
	$(wildcard $(MD_BUILDDIR)/*.md) \
	$(NULL)

# files that are copied from sources
EXTRA_DIST := \
	$(srcdir)/images 					\
	$(srcdir)/css 						\
	$(srcdir)/pandoc-template.html5		\
	$(srcdir)/favicon.ico				\
    $(NULL)

.PHONY: all docs docs-copy docs-build-html

#
# Docs are not built as part of normal build
#
all:
	@echo "======= Run 'make docs' in the xmlsec/docs folder to rebuild docs"

#
# Convert all *.md files from docs/md/ to HTML using pandoc.
# The pandoc template adds the navigation panel and <head> structure.
#

if BUILD_HTML_DOCS

docs: $(MD_SRC_FILES)

	@echo "-- Generating HTML from Markdown files in $(MD_SRCDIR) ..."
	@for f in $(MD_SRC_FILES); do \
		out=$(builddir)/`basename $$f .md`.html ; \
		title=`grep -m1 '^# ' $$f | sed -E 's/^# //'` ; \
		echo "--- Converting $$f -> $$out (title: $$title)" ; \
		$(PANDOC) \
			--standalone \
			--template=$(srcdir)/pandoc-template.html5 \
			--from=markdown --to=html5 \
			--metadata title="$$title" \
			--output=$$out \
			$$f ; \
		$(SED) -E -i 's|href="(\.\./)*api/index\.md(#[^"]*)?"|href="https://github.com/lsh123/xmlsec/wiki/API-Index\2"|g' $$out ; \
		$(SED) -E -i 's|href="(\.\./)*tutorial/index\.md(#[^"]*)?"|href="https://github.com/lsh123/xmlsec/wiki/Tutorial-Index\2"|g' $$out ; \
		$(SED) -E -i 's|href="(\.\./)*examples/index\.md(#[^"]*)?"|href="https://github.com/lsh123/xmlsec/wiki/Examples-Index\2"|g' $$out ; \
		$(SED) -E -i 's|href="([^"#:]*)\.md(#[^"]*)?"|href="\1.html\2"|g' $$out ; \
		$(SED) -E -i 's|<td([^>]*)>(Yes)|<td class="supported-feature"\1>\2|g' $$out ; \
	done
	@echo "-- Copying source html to build folder ..."
	@if [ z"$(srcdir)" != z"$(builddir)" ] ; then  \
		$(CP)  $(srcdir)/*.ico $(builddir)/ ; \
		mkdir -p  $(builddir)/images $(builddir)/css ; \
		$(CP) -r $(srcdir)/images/* $(builddir)/images/ ; \
		$(CP) -r $(srcdir)/css/* $(builddir)/css/ ; \
	fi

else

docs:
	@( \
		echo "=== ERROR: To build docs, make sure all necessary tools are installed" ; \
		echo "SED:      $(SED)" ; \
		echo "SORT:     $(SORT)" ; \
		echo "PANDOC:   $(PANDOC)" ; \
		exit 1; \
	)

endif

clean-local:
	@( \
		$(RM) -f *.stamp ; \
		$(RM) -rf $(builddir)/*.html ; \
		if [ z"$(srcdir)" != z"$(builddir)" ] ; then \
			$(RM) -rf $(builddir)/*.ico ; \
			$(RM) -rf $(builddir)/images ; \
			$(RM) -rf $(builddir)/css ; \
		fi ; \
	 )

distclean-local: clean-local