Merge branch 'main' of https://github.com/zcash/zips into frost-randomizer

Author: conradoplg

.github/workflows/render.yml

@@ -13,8 +13,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/[email protected]
-        with: 
-          token: ${{ secrets.CI_TOKEN }}
+        # with: 
+          # token: ${{ secrets.CI_TOKEN }}
 
       - name: Compile ZIPs and Zcash Protocol Specification
         uses: ./.github/actions/render

.gitignore

@@ -19,15 +19,14 @@
 *.swp
 *.save
 *.save.*
+*~
+*.html.temp
 
 .Makefile.uptodate
 .zipfilelist.*
 .draftfilelist.*
 
-protocol/aux/
-protocol/html/
-protocol/saplinghtml/
+MultiMarkdown-6
 
-protocol/heartwood.pdf
+protocol/aux/
 protocol/protocol.ver
-*~

Dockerfile

@@ -2,10 +2,10 @@ FROM debian:latest
 
 RUN apt-get update
 RUN apt-get install -y \
-        gawk \
         perl \
         sed \
         git \
+        cmake \
         python3 \
         python3-pip \
         pandoc \
@@ -18,7 +18,12 @@ RUN apt-get install -y \
         texlive-bibtex-extra
 
 RUN rm /usr/lib/python3.11/EXTERNALLY-MANAGED
-RUN pip install rst2html5
+RUN pip install 'docutils==0.21.2' 'rst2html5==2.0.1'
+
+RUN git config --global --add safe.directory /zips
+
+# Use a fork so that we're running pinned code.
+RUN git clone -b develop https://github.com/Electric-Coin-Company/MultiMarkdown-6 && cd MultiMarkdown-6 && make release && cd build && make && make install
 
 ENV PATH=${PATH}:/root/.local/bin
 

Makefile

@@ -1,6 +1,8 @@
-# Dependencies: see zip-guide.rst and protocol/README.rst
+# Dependencies: see zips/zip-guide.rst and protocol/README.rst
 
-.PHONY: all all-zips tag-release protocol discard
+MARKDOWN_OPTION?=--mmd
+
+.PHONY: all-zips all tag-release protocol all-protocol discard
 all-zips: .Makefile.uptodate
 	echo "$(patsubst zips/%,%,$(sort $(wildcard zips/zip-*.rst) $(wildcard zips/zip-*.md)))" >.zipfilelist.new
 	diff .zipfilelist.current .zipfilelist.new || cp -f .zipfilelist.new .zipfilelist.current
@@ -11,50 +13,49 @@ all-zips: .Makefile.uptodate
 	$(MAKE) README.rst
 	$(MAKE) rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md))))))
 
-all: all-zips protocol
+all: all-zips all-protocol
 
 tag-release:
 	$(MAKE) -C protocol tag-release
 
 protocol:
-	$(MAKE) -C protocol
+	$(MAKE) -C protocol protocol
+
+protocol-dark:
+	$(MAKE) -C protocol protocol-dark
+
+all-protocol:
+	$(MAKE) -C protocol all
+
+all-specs: all-zips
+	$(MAKE) -C protocol all-specs
 
 discard:
 	git checkout -- 'rendered/*.html' 'README.rst' 'rendered/protocol/*.pdf'
 
-.Makefile.uptodate: Makefile edithtml.sh
+.Makefile.uptodate: Makefile render.sh
 	$(MAKE) clean
 	touch .Makefile.uptodate
 
-define PROCESSRST
-$(eval TITLE := $(shell echo '$(patsubst zips/%,%,$(basename $<))' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||'))
-rst2html5 -v --title="$(TITLE)" $< >$@
-./edithtml.sh --rst $@
-endef
+rendered/index.html: README.rst render.sh
+	./render.sh --rst $< $@
 
-define PROCESSMD
-$(eval TITLE := $(shell echo '$(patsubst zips/%,%,$(basename $<))' | sed -E 's|zip-0{0,3}|ZIP |;s|draft-|Draft |')$(shell grep -E '^(\.\.)?\s*Title: ' $< |sed -E 's|.*Title||'))
-pandoc --from=markdown --to=html $< --output=$@
-./edithtml.sh --md $@ "${TITLE}"
-endef
+rendered/%.html: zips/%.rst render.sh
+	./render.sh --rst $< $@
 
-rendered/index.html: README.rst edithtml.sh
-	$(PROCESSRST)
-
-rendered/%.html: zips/%.rst edithtml.sh
-	$(PROCESSRST)
-
-rendered/%.html: zips/%.md edithtml.sh
-	$(PROCESSMD)
+rendered/%.html: zips/%.md render.sh
+	./render.sh $(MARKDOWN_OPTION) $< $@
 
 README.rst: .zipfilelist.current .draftfilelist.current makeindex.sh README.template $(wildcard zips/zip-*.rst) $(wildcard zips/zip-*.md) $(wildcard zips/draft-*.rst) $(wildcard zips/draft-*.md)
 	./makeindex.sh | cat README.template - >README.rst
 
-.PHONY: linkcheck
-linkcheck: all-zips
-	$(MAKE) -C protocol all-specs
-	./links_and_dests.py --check $(filter-out $(wildcard rendered/draft-*.html),$(wildcard rendered/*.html)) rendered/protocol/protocol.pdf rendered/protocol/canopy.pdf rendered/protocol/heartwood.pdf rendered/protocol/blossom.pdf rendered/protocol/sapling.pdf
+.PHONY: linkcheck clean all-clean
+linkcheck: all
+	./links_and_dests.py --check $(filter-out $(wildcard rendered/draft-*.html),$(wildcard rendered/*.html)) $(filter-out rendered/protocol/sprout.pdf,$(wildcard rendered/protocol/*.pdf))
 
-.PHONY: clean
 clean:
 	rm -f .zipfilelist.* README.rst rendered/index.html $(addprefix rendered/,$(addsuffix .html,$(basename $(patsubst zips/%,%,$(sort $(wildcard zips/*.rst) $(wildcard zips/*.md))))))
+
+all-clean:
+	$(MAKE) clean
+	$(MAKE) -C protocol clean