Skip to content

Commit 0b6caf9

Browse files
Add RTD docs configuration file
Adds a RTD configuration file (v2) to customize builds. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent ef210cd commit 0b6caf9

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

.readthedocs.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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
6+
version: 2
7+
8+
# Where the Sphinx conf.py file is located
9+
sphinx:
10+
configuration: docs/source/conf.py
11+
12+
# Setting the python version and doc build requirements
13+
python:
14+
install:
15+
- method: pip
16+
path: .
17+
extra_requirements:
18+
- docs

setup.cfg

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,7 @@ testing =
3535
# upstream
3636
pytest >= 6
3737
pytest-xdist >= 2
38+
docs=
39+
Sphinx>=3.3.1
40+
sphinx-rtd-theme>=0.5.0
41+
doc8>=0.8.1

0 commit comments

Comments
 (0)