Merge pull request #943 from GaloisInc/feature-remote-api-docs

Remote API Docs
GaloisInc · Dec 3, 2020 · 14bab8f · 14bab8f
2 parents 7d8e7ea + ea36de4
commit 14bab8f
Show file tree

Hide file tree

Showing 7 changed files with 655 additions and 2 deletions.
diff --git a/deps/argo b/deps/argo
diff --git a/deps/cryptol b/deps/cryptol
diff --git a/saw-remote-api/docs/.gitignore b/saw-remote-api/docs/.gitignore
@@ -0,0 +1 @@
+_build/
diff --git a/saw-remote-api/docs/Makefile b/saw-remote-api/docs/Makefile
@@ -0,0 +1,35 @@
+# 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
+
+# Documentation taken from Argo
+# Edit ARGODOCS if the dependency path changes; add reST files to ARGODEPS
+# that live in Argo but are needed here
+ARGODOCS = ../../deps/argo/docs
+ARGODEPS = Protocol.rst
+
+# Documentation taken from Cryptol Remote API
+# Edit CRYPTOLDOCS if the dependency path changes; add reST files to
+# CRYPTOLDEPS that live in Cryptol but are needed here
+CRYPTOLDOCS = ../../deps/cryptol/cryptol-remote-api/docs
+CRYPTOLDEPS = Cryptol.rst Errors.rst
+
+# 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
+	cp $(foreach d,$(ARGODEPS),$(ARGODOCS)/$(d)) .
+	cp $(foreach d,$(CRYPTOLDEPS),$(CRYPTOLDOCS)/$(d)) .
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	rm $(ARGODEPS) $(CRYPTOLDEPS)
+52 −190		README.rst
+0 −336		docs/Cryptol.rst
+0 −161		docs/Errors.rst
+0 −1		docs/Protocol.rst
+0 −1		docs/Python.rst
+0 −10		docs/SAW.rst
+0 −4		docs/index.rst
+1 −1		cryptol-remote-api/cryptol-remote-api.cabal
+1 −1		cryptol.cabal
+1 −1		deps/argo
+11 −3		src/Cryptol/Backend/SBV.hs
+13 −0		src/Cryptol/Symbolic/SBV.hs