Skip to content

Commit cea804d

Browse files
authored
Merge pull request #7 from freegs-plasma/add-readthedocs
Add readthedocs config
2 parents 96c61be + 72e2d7d commit cea804d

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@ instance/
170170

171171
# Sphinx documentation
172172
docs/_build/
173+
docs/source/_build
173174

174175
# PyBuilder
175176
target/

.readthedocs.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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-20.04
11+
tools:
12+
python: "3.8"
13+
14+
# Build documentation in the docs/ directory with Sphinx
15+
sphinx:
16+
configuration: docs/source/conf.py
17+
18+
# Optionally build your docs in additional formats such as PDF
19+
# formats:
20+
# - pdf
21+
22+
# Optionally declare the Python requirements required to build your docs
23+
python:
24+
install:
25+
- method: pip
26+
path: .
27+
extra_requirements:
28+
- docs
29+
system_packages: true

0 commit comments

Comments
 (0)