Skip to content

Commit 56c3617

Browse files
authored
Docs: Update ReadTheDocs to v2 (#673)
1 parent 50dfbe7 commit 56c3617

File tree

5 files changed

+84
-2
lines changed

5 files changed

+84
-2
lines changed

.readthedocs.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
version: 2
2+
3+
build:
4+
os: ubuntu-22.04
5+
tools:
6+
python: "3.11"
7+
8+
# Build from the docs/ directory with Sphinx
9+
sphinx:
10+
configuration: docs/conf.py
11+
fail_on_warning: true
12+
13+
# Explicitly set the version of Python and its requirements
14+
python:
15+
install:
16+
- requirements: docs/requirements.txt

docs/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
extensions = ["sphinx.ext.autodoc"]
3030

3131
# Add any paths that contain templates here, relative to this directory.
32-
templates_path = ["_templates"]
32+
templates_path = []
3333

3434
# List of patterns, relative to source directory, that match files and
3535
# directories to ignore when looking for source files.
@@ -53,7 +53,7 @@
5353
# Add any paths that contain custom static files (such as style sheets) here,
5454
# relative to this directory. They are copied after the builtin static files,
5555
# so a file named "default.css" will overwrite the builtin "default.css".
56-
html_static_path = ["_static"]
56+
html_static_path = []
5757

5858
# The master toctree document.
5959
master_doc = "index"

docs/requirements.in

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx<7.0.0
2+
sphinx_rtd_theme

docs/requirements.txt

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
#
2+
# This file is autogenerated by pip-compile with Python 3.9
3+
# by the following command:
4+
#
5+
# pip-compile --resolver=backtracking requirements.in
6+
#
7+
alabaster==0.7.13
8+
# via sphinx
9+
babel==2.12.1
10+
# via sphinx
11+
certifi==2023.5.7
12+
# via requests
13+
charset-normalizer==3.1.0
14+
# via requests
15+
docutils==0.18.1
16+
# via
17+
# sphinx
18+
# sphinx-rtd-theme
19+
idna==3.4
20+
# via requests
21+
imagesize==1.4.1
22+
# via sphinx
23+
importlib-metadata==6.6.0
24+
# via sphinx
25+
jinja2==3.1.2
26+
# via sphinx
27+
markupsafe==2.1.2
28+
# via jinja2
29+
packaging==23.1
30+
# via sphinx
31+
pygments==2.15.1
32+
# via sphinx
33+
requests==2.30.0
34+
# via sphinx
35+
snowballstemmer==2.2.0
36+
# via sphinx
37+
sphinx==6.2.1
38+
# via
39+
# -r requirements.in
40+
# sphinx-rtd-theme
41+
# sphinxcontrib-jquery
42+
sphinx-rtd-theme==1.2.0
43+
# via -r requirements.in
44+
sphinxcontrib-applehelp==1.0.4
45+
# via sphinx
46+
sphinxcontrib-devhelp==1.0.2
47+
# via sphinx
48+
sphinxcontrib-htmlhelp==2.0.1
49+
# via sphinx
50+
sphinxcontrib-jquery==4.1
51+
# via sphinx-rtd-theme
52+
sphinxcontrib-jsmath==1.0.1
53+
# via sphinx
54+
sphinxcontrib-qthelp==1.0.3
55+
# via sphinx
56+
sphinxcontrib-serializinghtml==1.1.5
57+
# via sphinx
58+
urllib3==2.0.2
59+
# via requests
60+
zipp==3.15.0
61+
# via importlib-metadata

pyproject.toml

+3
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ dynamic = [
5050
]
5151

5252
[project.optional-dependencies]
53+
docs = [
54+
"pip-tools>=6.13.0",
55+
]
5356
test = [
5457
"assertpy>=1.1",
5558
"beautifulsoup4>=4.11.1",

0 commit comments

Comments
 (0)