docs: Automatically link fuzzer/minitest README.md files.

Signed-off-by: Tim 'mithro' Ansell <me@mith.ro>
This commit is contained in:
Tim 'mithro' Ansell 2019-04-03 18:10:45 -07:00
parent bab4c6af06
commit 853b0119da
30 changed files with 45 additions and 29 deletions

2
docs/.gitignore vendored
View File

@ -1 +1,3 @@
_build
db_dev_process/fuzzers/*.md
db_dev_process/minitests/*.md

View File

@ -18,7 +18,49 @@ livehtml:
.PHONY: help livereload Makefile
# Update fuzzer / minitest markdown links.
fuzzers-links:
@cd db_dev_process/fuzzers; rm -f *.md
@cd db_dev_process/fuzzers; \
for i in ../../../fuzzers/*; do \
if [ ! -d $$i ]; then \
continue; \
fi; \
if [ -e $$i/README.md ]; then \
echo "Linking $$i/README.md"; \
ln -s $$i/README.md $$(basename $$i).md; \
else \
echo "Missing $$i/README.md"; \
echo "# $$(basename $$i)" > $$(basename $$i).md; \
echo "" >> $$(basename $$i).md; \
echo "Missing README.md!" >> $$(basename $$i).md; \
fi; \
done
minitests-links:
@cd db_dev_process/minitests; rm -f *.md
@cd db_dev_process/minitests; \
for i in ../../../minitests/*; do \
if [ ! -d $$i ]; then \
continue; \
fi; \
if [ -e $$i/README.md ]; then \
echo "Linking $$i/README.md"; \
ln -s $$i/README.md $$(basename $$i).md; \
else \
echo "Missing $$i/README.md"; \
echo "# $$(basename $$i)" > $$(basename $$i).md; \
echo "" >> $$(basename $$i).md; \
echo "Missing README.md!" >> $$(basename $$i).md; \
fi; \
done
links: fuzzers-links minitests-links
@true
.PHONY: fuzzers-links minitests-links links
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
%: Makefile links
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

View File

@ -1 +0,0 @@
../../../fuzzers/011-ffconfig/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/012-clbn5ffmux/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/013-clbncy0/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/014-ffsrcemux/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/015-clbnffmux/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/016-clbnoutmux/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/017-clbprecyinit/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/018-clbram/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/019-ndi1mux/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/050-intpips/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/051-imuxlout/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/052-clkin/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/053-ctrlin/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/054-gfan/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/055-gnd/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/056-rempips/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/057-bipips/README.md

View File

@ -1 +0,0 @@
../../../fuzzers/058-hclkpips/README.md

View File

@ -1 +0,0 @@
../../../minitests/bram/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_bused/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_ffcfg/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_muxf8/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_n5ffmux/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_ncy0/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_ndi1mux/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_nffmux/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_noutmux/README.md

View File

@ -1 +0,0 @@
../../../minitests/clb_ram/README.md