Skip to content

Commit

Permalink
Merge pull request #7 from freegs-plasma/add-readthedocs
Browse files Browse the repository at this point in the history
Add readthedocs config
  • Loading branch information
ZedThree authored Apr 5, 2023
2 parents 96c61be + 72e2d7d commit cea804d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ instance/

# Sphinx documentation
docs/_build/
docs/source/_build

# PyBuilder
target/
Expand Down
29 changes: 29 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.8"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py

# Optionally build your docs in additional formats such as PDF
# formats:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
system_packages: true

0 comments on commit cea804d

Please sign in to comment.