Skip to content

Commit 8404886

Browse files
Docs: Use Sphinx for the documentation (#80)
We're saying goodbye to MkDocs and switching over to Sphinx! This allows us to use intersphinx with the Python docs, and also allows us to have a nice reference documentation.
1 parent 4a62e03 commit 8404886

18 files changed

+1272
-747
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ dist/
1010
src/pyawaitable/pyawaitable.h
1111
pcbuild/
1212
*.o
13+
site/
14+
_build/
1315

1416
# LSP
1517
compile_flags.txt

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)

docs/adding_awaits.md

Lines changed: 0 additions & 280 deletions
This file was deleted.

0 commit comments

Comments
 (0)