nixpkgs/doc/Makefile

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

117 lines
4 KiB
Makefile
Raw Normal View History

2021-03-04 17:52:32 +01:00
MD_TARGETS=$(addsuffix .xml, $(basename $(shell find . -type f -regex '.*\.md$$' -not -name README.md)))
2018-03-24 16:36:10 +01:00
PANDOC ?= pandoc
pandoc_media_dir = media
# NOTE: Keep in sync with NixOS manual (/nixos/doc/manual/md-to-db.sh) and conversion script (/maintainers/scripts/db-to-md.sh).
# TODO: Remove raw-attribute when we can get rid of DocBook altogether.
pandoc_commonmark_enabled_extensions = +attributes+fenced_divs+footnotes+bracketed_spans+definition_lists+pipe_tables+raw_attribute
# Not needed:
# - docbook-reader/citerefentry-to-rst-role.lua (only relevant for DocBook → MarkDown/rST/MyST)
pandoc_flags = --extract-media=$(pandoc_media_dir) \
--lua-filter=$(PANDOC_LUA_FILTERS_DIR)/diagram-generator.lua \
--lua-filter=build-aux/pandoc-filters/myst-reader/roles.lua \
2021-07-12 18:40:33 +02:00
--lua-filter=build-aux/pandoc-filters/link-unix-man-references.lua \
--lua-filter=build-aux/pandoc-filters/docbook-writer/rst-roles.lua \
2021-07-12 04:38:41 +02:00
--lua-filter=build-aux/pandoc-filters/docbook-writer/labelless-link-is-xref.lua \
-f commonmark$(pandoc_commonmark_enabled_extensions)+smart
2018-03-24 16:36:10 +01:00
.PHONY: all
2018-05-01 04:35:54 +02:00
all: validate format out/html/index.html out/epub/manual.epub
2018-03-24 16:36:10 +01:00
2018-03-26 02:01:31 +02:00
.PHONY: debug
debug:
nix-shell --run "xmloscopy --docbook5 ./manual.xml ./manual-full.xml"
2018-03-26 14:24:27 +02:00
2018-05-01 04:35:54 +02:00
.PHONY: format
format: doc-support/result
find . -iname '*.xml' -type f | while read f; do \
echo $$f ;\
xmlformat --config-file "doc-support/result/xmlformat.conf" -i $$f ;\
done
2018-05-01 04:35:54 +02:00
.PHONY: fix-misc-xml
fix-misc-xml:
find . -iname '*.xml' -type f \
-exec ../nixos/doc/varlistentry-fixer.rb {} ';'
2018-03-24 16:36:10 +01:00
.PHONY: clean
clean:
rm -f ${MD_TARGETS} doc-support/result .version manual-full.xml functions/library/locations.xml functions/library/generated
rm -rf ./out/ ./highlightjs ./media
2018-03-24 16:36:10 +01:00
.PHONY: validate
validate: manual-full.xml doc-support/result
jing doc-support/result/docbook.rng manual-full.xml
2018-03-24 16:36:10 +01:00
2019-07-04 14:46:47 +02:00
out/html/index.html: doc-support/result manual-full.xml style.css highlightjs
2018-03-24 16:36:10 +01:00
mkdir -p out/html
2019-07-04 15:06:39 +02:00
xsltproc \
2018-03-24 16:36:10 +01:00
--nonet --xinclude \
--output $@ \
2019-07-04 15:06:39 +02:00
doc-support/result/xhtml.xsl \
2018-03-24 16:36:10 +01:00
./manual-full.xml
2018-03-26 14:24:27 +02:00
mkdir -p out/html/highlightjs/
cp -r highlightjs out/html/
cp -r $(pandoc_media_dir) out/html/
cp ./overrides.css out/html/
2018-03-24 16:36:10 +01:00
cp ./style.css out/html/style.css
mkdir -p out/html/images/callouts
2019-07-04 14:46:47 +02:00
cp doc-support/result/xsl/docbook/images/callouts/*.svg out/html/images/callouts/
2018-03-26 14:24:27 +02:00
chmod u+w -R out/html/
2018-03-24 16:36:10 +01:00
out/epub/manual.epub: manual-full.xml
2018-03-24 16:36:10 +01:00
mkdir -p out/epub/scratch
2019-07-04 15:06:39 +02:00
xsltproc --nonet \
2018-03-24 16:36:10 +01:00
--output out/epub/scratch/ \
2019-07-04 15:06:39 +02:00
doc-support/result/epub.xsl \
2018-03-24 16:36:10 +01:00
./manual-full.xml
cp -r $(pandoc_media_dir) out/epub/scratch/OEBPS
cp ./overrides.css out/epub/scratch/OEBPS
2018-03-26 20:04:19 +02:00
cp ./style.css out/epub/scratch/OEBPS
mkdir -p out/epub/scratch/OEBPS/images/callouts/
2019-07-04 14:46:47 +02:00
cp doc-support/result/xsl/docbook/images/callouts/*.svg out/epub/scratch/OEBPS/images/callouts/
2018-03-24 16:36:10 +01:00
echo "application/epub+zip" > mimetype
zip -0Xq "out/epub/manual.epub" mimetype
rm mimetype
cd "out/epub/scratch/" && zip -Xr9D "../manual.epub" *
rm -rf "out/epub/scratch/"
highlightjs: doc-support/result
2018-03-26 14:24:27 +02:00
mkdir -p highlightjs
cp -r doc-support/result/highlightjs/highlight.pack.js highlightjs/
cp -r doc-support/result/highlightjs/LICENSE highlightjs/
cp -r doc-support/result/highlightjs/mono-blue.css highlightjs/
cp -r doc-support/result/highlightjs/loader.js highlightjs/
2018-03-26 14:24:27 +02:00
manual-full.xml: ${MD_TARGETS} .version functions/library/locations.xml functions/library/generated *.xml **/*.xml **/**/*.xml
2018-03-24 16:36:10 +01:00
xmllint --nonet --xinclude --noxincludenode manual.xml --output manual-full.xml
.version: doc-support/result
ln -rfs ./doc-support/result/version .version
2018-03-24 16:36:10 +01:00
doc-support/result: doc-support/default.nix
(cd doc-support; nix-build)
functions/library/locations.xml: doc-support/result
ln -rfs ./doc-support/result/function-locations.xml functions/library/locations.xml
functions/library/generated: doc-support/result
ln -rfs ./doc-support/result/function-docs functions/library/generated
2018-03-24 16:36:10 +01:00
%.section.xml: %.section.md
$(PANDOC) $^ -t docbook \
$(pandoc_flags) \
-o $@
2018-03-24 16:36:10 +01:00
%.chapter.xml: %.chapter.md
$(PANDOC) $^ -t docbook \
2018-03-24 16:36:10 +01:00
--top-level-division=chapter \
$(pandoc_flags) \
-o $@