Skip to content

Commit e2cf701

Browse files
committed
docs: create official docs
1 parent f413219 commit e2cf701

53 files changed

Lines changed: 5683 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.readthedocs.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# .readthedocs.yaml
2+
version: 2
3+
4+
# Build configuration for Read the Docs
5+
build:
6+
os: ubuntu-22.04
7+
tools:
8+
python: "3.11" # Match your project’s Python version
9+
10+
sphinx:
11+
configuration: docs/conf.py # Path to your Sphinx conf.py
12+
13+
# Optionally build PDF & ePub
14+
formats:
15+
- pdf
16+
- epub
17+
18+
# Install your package and dependencies
19+
python:
20+
install:
21+
- method: pip
22+
path: .
23+
- requirements: docs/requirements.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)
99.1 KB
Binary file not shown.

docs/_build/doctrees/index.doctree

2.84 KB
Binary file not shown.
2.71 KB
Binary file not shown.
19.4 KB
Binary file not shown.
114 KB
Binary file not shown.
137 KB
Binary file not shown.
54 KB
Binary file not shown.
5.87 KB
Binary file not shown.

0 commit comments

Comments
 (0)