diff --git a/.gitignore b/.gitignore index ccb36fd..52454fd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -/build/* +_build/* .ipynb_checkpoints /.pixi/* diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# 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 + +# 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/index.md b/index.md index 97bd833..18eff3f 100644 --- a/index.md +++ b/index.md @@ -3,6 +3,6 @@ ```{toctree} :maxdepth: 1 :glob: -recipes/**/* +tutorials/**/* contributing ``` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..df354a5 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +# For site +sphinx +myst-nb +sphinx-book-theme +ipympl +sphinx-copybutton +# For tutorials +matplotlib