Skip to content

Commit f48be15

Browse files
Update ReadtheDocs
1 parent ff1ca49 commit f48be15

File tree

5 files changed

+39
-61
lines changed

5 files changed

+39
-61
lines changed

.readthedocs.yml

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,32 @@
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-22.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+
18+
# Build documentation in the "docs/" directory with Sphinx
19+
sphinx:
20+
configuration: docs/conf.py
21+
22+
# Optionally build your docs in additional formats such as PDF and ePub
23+
# formats:
24+
# - pdf
25+
# - epub
26+
27+
# Optional but recommended, declare the Python requirements required
28+
# to build your documentation
29+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
130
python:
2-
version: 3
331
install:
4-
- requirements: docs/requirements.txt
5-
setup_py_install: true
32+
- requirements: docs/requirements.txt

docs/Makefile

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

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
'sphinx.ext.autodoc',
3535
'sphinx.ext.intersphinx',
3636
'sphinx.ext.viewcode',
37-
'm2r'
37+
'm2r2'
3838
]
3939

4040
source_suffix = ['.rst', '.md']

docs/make.bat

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

docs/requirements.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1-
m2r
2-
sparkfun-qwiic-i2c
1+
m2r2
2+
sparkfun-qwiic-i2c
3+
sparkfun-qwiic-tca9548a
4+
5+
# Defining the exact version will make sure things don't break
6+
sphinx==5.3.0
7+
sphinx_rtd_theme==1.1.1
8+
readthedocs-sphinx-search==0.1.1

0 commit comments

Comments
 (0)