diff options
| author | Yann Herklotz <git@yannherklotz.com> | 2022-03-26 21:08:23 +0000 |
|---|---|---|
| committer | Yann Herklotz <git@yannherklotz.com> | 2022-03-26 21:08:23 +0000 |
| commit | 11d6215f265d0dbcfd0048819a614f318a0775a4 (patch) | |
| tree | 16b0450e4df7caaed57400d503044ca92f1f3c38 /doc/Makefile | |
| parent | a5b8a41ef22618c69db62dfeb71d7f38bbba34e2 (diff) | |
| download | vericert-11d6215f265d0dbcfd0048819a614f318a0775a4.tar.gz vericert-11d6215f265d0dbcfd0048819a614f318a0775a4.zip | |
Add sphinx documentation
Diffstat (limited to 'doc/Makefile')
| -rw-r--r-- | doc/Makefile | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..5662645 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,24 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build +SOURCE_DATE_EPOCH = $(shell git log -1 --format=%ct) + +VS_DOCS := ../src/Compiler.v ../src/hls/RTLBlockInstr.v + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + $(foreach d,$(VS_DOCS),cp $(d) $(patsubst ../%,%,$(d));) + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |