sforman
/
Thun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Function Reference

This commit is contained in:
Simon Forman 2022-09-16 07:35:11 -07:00
parent ea52cd7bfb
commit b67fc46291
3 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -93,8 +93,14 @@ coordinate pair in a square spiral (like the kind used to construct an
### Jupyter Notebooks ### Jupyter Notebooks
[Notebooks](/notebooks/index.html)
The docs/notebooks dir contains Jupyter notebooks, ... TODO The docs/notebooks dir contains Jupyter notebooks, ... TODO
## Function Reference
[Function Reference](/FR.html)
### Building the Docs ### Building the Docs
Run `make` in the `docs` directory. Run `make` in the `docs` directory.

3
docs/Makefile
View File

@ -1,3 +1,5 @@
# Docs toplevel makefile.
README=../README.md README=../README.md
BUILD_SCRIPT=build_index.py BUILD_SCRIPT=build_index.py
GENERATOR=python $(BUILD_SCRIPT) 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) # python -m markdown -f index.html -o html $(README)

20
docs/notebooks/Makefile
View File

@ -1,21 +1,23 @@
# Docs notebook makefile.
docs = $(wildcard *.ipynb) docs = $(wildcard *.ipynb)
docs_html = $(patsubst %.ipynb,%.html,$(docs)) docs_html = $(patsubst %.ipynb,%.html,$(docs))
.PHONY: clean sdist test docs .PHONY: clean
all: $(docs_html)
all: mov
clean: clean:
$(RM) -v $(docs_html) $(RM) -v $(docs_html)
index.html: build_index.py
python build_index.py > index.html
$(docs_html): %.html : %.ipynb $(docs_html): %.html : %.ipynb
python -m nbconvert --to html $< jupyter nbconvert --to html --template lab $<
mov: $(docs_html) index.html
cp -v $? ../html/notebooks/
# markdown Functor-Reference.md | tidy5 -utf8 --add-meta-charset yes > ../../html/FR.html
mov: $(move_us)
cp -v $? ./sphinx_docs/notebooks/