2022-05-07 23:48:58 +08:00
|
|
|
# Minimal makefile for Sphinx documentation
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
# You can set these variables from the command line.
|
|
|
|
|
SPHINXOPTS =
|
|
|
|
|
SPHINXAPIDOC = sphinx-apidoc
|
|
|
|
|
SPHINXBUILD = sphinx-build
|
|
|
|
|
SPHINXPROJ = fastNLP
|
2022-05-09 20:54:08 +08:00
|
|
|
SPHINXEXCLUDE = ../fastNLP/transformers/*
|
2022-05-07 23:48:58 +08:00
|
|
|
SOURCEDIR = source
|
|
|
|
|
BUILDDIR = build
|
2022-05-19 17:04:58 +08:00
|
|
|
PORT = 8000
|
2022-05-07 23:48:58 +08:00
|
|
|
|
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
|
|
|
help:
|
|
|
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
|
|
|
|
|
|
|
|
|
|
apidoc:
|
2022-05-09 22:54:30 +08:00
|
|
|
$(SPHINXAPIDOC) -efM -o source ../$(SPHINXPROJ) $(SPHINXEXCLUDE)
|
2022-05-07 23:48:58 +08:00
|
|
|
|
|
|
|
|
server:
|
|
|
|
|
cd build/html && python -m http.server $(PORT)
|
|
|
|
|
|
|
|
|
|
delete:
|
|
|
|
|
rm -f source/$(SPHINXPROJ).* source/modules.rst && rm -rf build
|
|
|
|
|
|
2022-05-09 22:54:30 +08:00
|
|
|
web:
|
|
|
|
|
make html && make server
|
|
|
|
|
|
2022-05-07 23:48:58 +08:00
|
|
|
dev:
|
|
|
|
|
make delete && make apidoc && make html && make server
|
|
|
|
|
|
2022-05-19 17:04:58 +08:00
|
|
|
versions:
|
|
|
|
|
sphinx-multiversion "$(SOURCEDIR)" "$(BUILDDIR)" && cd build && python -m http.server $(PORT)
|
|
|
|
|
|
2022-05-07 23:48:58 +08:00
|
|
|
prod:
|
|
|
|
|
make apidoc && make html
|
|
|
|
|
|
|
|
|
|
.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)
|
