Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remote API Docs #943

Merged
merged 8 commits into from
Dec 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion deps/argo
1 change: 1 addition & 0 deletions saw-remote-api/docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build/
35 changes: 35 additions & 0 deletions saw-remote-api/docs/Makefile
Original file line number Diff line number Diff line change
@@ -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)
Loading