diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..216a257 --- /dev/null +++ b/Makefile @@ -0,0 +1,12 @@ +SHELL := /bin/bash -euxo pipefail + +# Treat Sphinx warnings as errors +SPHINXOPTS := -W + +.PHONY: docs +docs: + make -C docs clean html SPHINXOPTS=$(SPHINXOPTS) + +.PHONY: open-docs +open-docs: + python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("docs/build/html/index.html"))' diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..aae2ad2 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = DCOSE2E +SOURCEDIR = source +BUILDDIR = build + +# 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 + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst new file mode 100644 index 0000000..09929fe --- /dev/null +++ b/docs/source/changelog.rst @@ -0,0 +1 @@ +.. include:: ../../CHANGELOG.rst diff --git a/docs/source/commands.rst b/docs/source/commands.rst new file mode 100644 index 0000000..98c0639 --- /dev/null +++ b/docs/source/commands.rst @@ -0,0 +1,6 @@ +Commands +======== + +.. click:: doccmd:main + :prog: doccmd + :show-nested: