Skip to content

Commit 5e17aa7

Browse files
Merge pull request #201 from oscarbenjamin/pr_rtd
Add readthedocs config file
2 parents 67e3997 + ac782a3 commit 5e17aa7

File tree

3 files changed

+49
-0
lines changed

3 files changed

+49
-0
lines changed

.readthedocs.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the OS, Python version and other tools you might need
9+
build:
10+
os: ubuntu-24.04
11+
tools:
12+
python: "3.12"
13+
# You can also specify other tool versions:
14+
# nodejs: "19"
15+
# rust: "1.64"
16+
# golang: "1.19"
17+
apt_packages:
18+
- libflint-dev
19+
20+
# Build documentation in the "docs/" directory with Sphinx
21+
sphinx:
22+
configuration: docs/conf.py
23+
24+
# Optionally build your docs in additional formats such as PDF and ePub
25+
# formats:
26+
# - pdf
27+
# - epub
28+
29+
# Optional but recommended, declare the Python requirements required
30+
# to build your documentation
31+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
32+
python:
33+
install:
34+
- sphinx

doc/conf.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""Sphinx configuration."""
2+
3+
from datetime import datetime
4+
5+
project = "python-Flint"
6+
author = "Fredrik Johansson"
7+
copyright = f"{datetime.now().year}, {author}"
8+
extensions = [
9+
"sphinx.ext.autodoc",
10+
"sphinx.ext.napoleon",
11+
"sphinx_rtd_theme",
12+
]
13+
#autodoc_typehints = "description"
14+
html_theme = "sphinx_rtd_theme"

requirements-dev.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ meson-python
66
pytest
77
coverage
88
pytest-cov
9+
sphinx

0 commit comments

Comments
 (0)