Skip to content

Commit

Permalink
Merge pull request #94 from nsoranzo/rtd_config
Browse files Browse the repository at this point in the history
Add now mandatory readthedocs config files
  • Loading branch information
jmchilton authored Jul 19, 2024
2 parents eb07ecc + 17fe445 commit 5811bc5
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
28 changes: 28 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"

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

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

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- path: .
- requirements: docs/requirements.txt
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
sphinx
sphinx-rtd-theme
5 changes: 3 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@ deps =
lint: flake8-import-order
lint: flake8-bugbear
lint,lintdocstrings: flake8
lintdocs: -rdocs/requirements.txt
lintdocstrings: flake8_docstrings
mypy: mypy
mypy: types-PyYAML
mypy: types-requests
unit,lintdocs: -rrequirements.txt
unit,lintdocs: -rdev-requirements.txt
unit: -rrequirements.txt
unit: -rdev-requirements.txt
lintreadme: readme
skip_install =
lint,lintdocstrings,lintreadme: True
Expand Down

0 comments on commit 5811bc5

Please # to comment.