Skip to content

Commit 7c311ce

Browse files
committed
Migrate documentation from Sphinx to Zensical
1 parent 0a8ec78 commit 7c311ce

42 files changed

Lines changed: 4903 additions & 6135 deletions

Some content is hidden

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

‎.gitignore‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ instance/
7171

7272
# Sphinx documentation
7373
docs/_build/
74+
zdoc/site/
75+
zdoc/firebird-driver.docset/
7476

7577
# PyBuilder
7678
target/
@@ -118,9 +120,6 @@ venv.bak/
118120
# Rope project settings
119121
.ropeproject
120122

121-
# mkdocs documentation
122-
/site
123-
124123
# mypy
125124
.mypy_cache/
126125
.dmypy.json
@@ -140,7 +139,6 @@ dmypy.json
140139
notes/
141140
store/
142141

143-
# Sphinx build
144-
docs/_build
142+
# Zensical build
143+
docs/site
145144
docs/firebird-driver.docset
146-

‎.readthedocs.yml‎

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
1-
# .readthedocs.yml
2-
# Read the Docs configuration file
3-
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4-
5-
# Required
61
version: 2
72

8-
# Build documentation in the docs/ directory with Sphinx
9-
sphinx:
10-
configuration: docs/conf.py
11-
123
build:
13-
os: "ubuntu-22.04"
4+
os: ubuntu-24.04
145
tools:
156
python: "3.11"
16-
17-
# Optionally set the version of Python and requirements required to build your docs
18-
python:
7+
jobs:
198
install:
20-
- requirements: docs/requirements.txt
9+
- pip install . zensical mkdocstrings-python
10+
build:
11+
html:
12+
- cd docs && zensical build
13+
post_build:
14+
- mkdir -p $READTHEDOCS_OUTPUT/html/
15+
- cp --recursive docs/site/. $READTHEDOCS_OUTPUT/html/

‎docs/Makefile‎

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

0 commit comments

Comments
 (0)