Skip to content

Commit be201cc

Browse files
authored
(update) Switch from mkdocs to sphinx for documentation generation (#10)
1 parent 0b9daa6 commit be201cc

30 files changed

Lines changed: 677 additions & 210 deletions

.gitignore

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
.venv/
1+
venv/
22
site/
3-
.obsidian/
3+
.obsidian/
4+
5+
# Generated files for the documentation
6+
docs/_build/

.gitmodules

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[submodule "apparun"]
2+
path = apparun
3+
url = https://github.com/appalca/apparun.git
4+
[submodule "appabuild"]
5+
path = appabuild
6+
url = https://github.com/appalca/appabuild.git

appabuild

Submodule appabuild added at 658e960

apparun

Submodule apparun added at a070a73

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
File renamed without changes.

0 commit comments

Comments
 (0)