From b67fc462911e6f2fa5d9645def6c7f5de8a6c79e Mon Sep 17 00:00:00 2001 From: Simon Forman Date: Fri, 16 Sep 2022 07:35:11 -0700 Subject: [PATCH] Function Reference --- README.md | 6 ++++++ docs/Makefile | 3 ++- docs/notebooks/Makefile | 20 +++++++++++--------- 3 files changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9c78726..be6900c 100644 --- a/README.md +++ b/README.md @@ -93,8 +93,14 @@ coordinate pair in a square spiral (like the kind used to construct an ### Jupyter Notebooks +[Notebooks](/notebooks/index.html) + The docs/notebooks dir contains Jupyter notebooks, ... TODO +## Function Reference + +[Function Reference](/FR.html) + ### Building the Docs Run `make` in the `docs` directory. diff --git a/docs/Makefile b/docs/Makefile index c704b9d..a6d5321 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,3 +1,5 @@ +# Docs toplevel makefile. + README=../README.md BUILD_SCRIPT=build_index.py GENERATOR=python $(BUILD_SCRIPT) @@ -12,4 +14,3 @@ $(HTML_OUTPUT_DIR)/index.html: $(README) $(BUILD_SCRIPT) # python -m markdown -f index.html -o html $(README) - diff --git a/docs/notebooks/Makefile b/docs/notebooks/Makefile index cc32d2e..02b9187 100644 --- a/docs/notebooks/Makefile +++ b/docs/notebooks/Makefile @@ -1,21 +1,23 @@ +# Docs notebook makefile. + docs = $(wildcard *.ipynb) docs_html = $(patsubst %.ipynb,%.html,$(docs)) -.PHONY: clean sdist test docs - - -all: $(docs_html) +.PHONY: clean +all: mov clean: $(RM) -v $(docs_html) +index.html: build_index.py + python build_index.py > index.html $(docs_html): %.html : %.ipynb - python -m nbconvert --to html $< + jupyter nbconvert --to html --template lab $< + +mov: $(docs_html) index.html + cp -v $? ../html/notebooks/ - -mov: $(move_us) - cp -v $? ./sphinx_docs/notebooks/ - +# markdown Functor-Reference.md | tidy5 -utf8 --add-meta-charset yes > ../../html/FR.html