Skip to content

Commit 8f60c00

Browse files
committed
.readthedocs.yaml & specify theme
1 parent 2b52fd7 commit 8f60c00

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

.readthedocs.yaml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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 version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.8"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
configuration: docs/conf.py
17+
18+
# We recommend specifying your dependencies to enable reproducible builds:
19+
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20+
python:
21+
install:
22+
- method: pip
23+
path: .

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33

44
master_doc = 'index'
55

6-
extensions = ['sphinxcontrib.jsonschema']
6+
extensions = ['sphinxcontrib.jsonschema', 'sphinx_rtd_theme']
77

88
html_extra_path = [
99
'example_components.json',
1010
'example_schema.json',
1111
'example_schema_with_external_refs.json'
1212
]
13+
14+
html_theme = "sphinx_rtd_theme"

setup.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@
4444
'flake8<6',
4545
'lxml',
4646
'pytest',
47+
'sphinx',
48+
'sphinx-rtd-theme',
4749
],
4850
},
4951
namespace_packages=['sphinxcontrib'],

0 commit comments

Comments
 (0)