Merge pull request #60 from daniellimws/license-ci
ci: Add scripts to check for necessary headers
diff --git a/docs/Makefile b/docs/Makefile
index 8e8fe65..d4a3bc0 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -9,6 +9,7 @@
# Minimal makefile for Sphinx documentation
#
+SHELL = /bin/bash
MAKEDIR := $(dir $(lastword $(MAKEFILE_LIST)))
# You can set these variables from the command line.
@@ -18,6 +19,21 @@
SPHINXPROJ = SymbiFlowV2X
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:
@@ -29,15 +45,15 @@
.PHONY: help livehtml Makefile
-env/Miniconda3-latest-Linux-x86_64.sh:
+env/Miniconda3-latest-$(OSFLAG)-x86_64.sh:
mkdir env
- wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O env/Miniconda3-latest-Linux-x86_64.sh
- chmod a+x env/Miniconda3-latest-Linux-x86_64.sh
+ 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-Linux-x86_64.sh
- ./env/Miniconda3-latest-Linux-x86_64.sh -p $(PWD)/env -b -f
+ 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
diff --git a/docs/conf.py b/docs/conf.py
index ccbda5f..e41a90e 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -124,7 +124,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'sphinx_materialdesign_theme'
+html_theme = 'sphinx_symbiflow_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -186,18 +186,6 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# This is required for the alabaster theme
-# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
- '**': [
- 'relations.html', # needs 'show_related': True theme option to display
- 'searchbox.html',
- ]
-}
-
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
diff --git a/docs/requirements.txt b/docs/requirements.txt
index fb96629..eb5a223 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,4 @@
-sphinx_materialdesign_theme
+git+http://github.com/SymbiFlow/sphinx_materialdesign_theme.git@master#egg=sphinx_symbiflow_theme
docutils
sphinx