adf860ea40
- Provides a toplevel documentation structure using Sphinx - Adds a `doc-html` target to the main Makefile - Converts existing documentation to RST format - Add some new documentation / tutorials - Links the developer manual and OCaml documentation - Synchronized documentation on Gitlab pages This patch is co-authored by: - Benjamin Canou <benjamin@canou.fr> - Bruno Bernardo <bernardobruno@gmail.com> - Pietro Abate <pietro.abate@inria.fr>
26 lines
677 B
Makefile
26 lines
677 B
Makefile
# You can set these variables from the command line.
|
|
SPHINXOPTS = -aE -n
|
|
SPHINXBUILD = sphinx-build
|
|
SPHINXPROJ = Tezos
|
|
SOURCEDIR = .
|
|
BUILDDIR = _build
|
|
|
|
all: html linkcheck
|
|
|
|
linkcheck:
|
|
$(SPHINXBUILD) -b linkcheck "$(SOURCEDIR)" "$(BUILDDIR)"
|
|
|
|
introduction/readme.rst: ../README.rst
|
|
sed 's/TEZOS/How to build and run/' $< > $@
|
|
|
|
.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).
|
|
html: Makefile introduction/readme.rst
|
|
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
|
|
|
|
clean:
|
|
@-rm -Rf "$(BUILDDIR)"
|
|
@-rm introduction/readme.rst
|