summaryrefslogtreecommitdiffstats
path: root/docs/Makefile
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Makefile')
-rw-r--r--docs/Makefile65
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..01ff6c0
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,65 @@
+# Copyright (C) 2017-2020 The SymbiFlow Authors.
+#
+# Use of this source code is governed by a ISC-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/ISC
+#
+# SPDX-License-Identifier: ISC
+# Minimal makefile for Sphinx documentation
+
+
+SHELL = /bin/bash
+MAKEDIR := $(dir $(lastword $(MAKEFILE_LIST)))
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = [ -e env/bin/activate ] && source env/bin/activate; sphinx-build
+SPHINXAUTOBUILD = [ -e env/bin/activate ] && source env/bin/activate; sphinx-autobuild
+SPHINXPROJ = SymbiFlowFIF
+SOURCEDIR = .
+BUILDDIR = _build
+OSFLAG =
+UNAME_S := $(shell uname -s)
+ifneq (, $(findstring Linux, $(UNAME_S)))
+ OSFLAG := Linux
+endif
+ifeq ($(UNAME_S), Darwin)
+ OSFLAG := MacOSX
+endif
+ifneq (, $(findstring Cygwin, $(UNAME_S)))
+ OSFLAG := Linux
+endif
+ifneq (, $(findstring MINGW, $(UNAME_S)))
+ OSFLAG := Linux
+endif
+
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+livehtml:
+ @$(SPHINXAUTOBUILD) -b html --ignore \*.swp --ignore \*~ $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html"
+
+.PHONY: help livehtml Makefile
+
+
+env/Miniconda3-latest-$(OSFLAG)-x86_64.sh:
+ mkdir env
+ wget https://repo.anaconda.com/miniconda/Miniconda3-latest-$(OSFLAG)-x86_64.sh -O env/Miniconda3-latest-$(OSFLAG)-x86_64.sh
+ chmod a+x env/Miniconda3-latest-$(OSFLAG)-x86_64.sh
+
+env:
+ rm -rf env
+ make env/Miniconda3-latest-$(OSFLAG)-x86_64.sh
+ ./env/Miniconda3-latest-$(OSFLAG)-x86_64.sh -p $(PWD)/env -b -f
+ source env/bin/activate; conda config --system --add envs_dirs $(PWD)/env/envs
+ source env/bin/activate; conda config --system --add pkgs_dirs $(PWD)/env/pkgs
+ source env/bin/activate; conda env update --name base --file ./environment.yml
+
+.PHONY: env
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%:
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)