Skip to content

Commit

Permalink
chore: added required files for RTD
Browse files Browse the repository at this point in the history
added .readthedocs.yaml configuration file
added requirements.txt file.
  • Loading branch information
Rares Gaia committed Aug 16, 2024
1 parent 1f0fab9 commit 6ec126f
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: "0.1.2"

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

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

formats: all

# Optional but recommended, declare the Python requirements required
python:
install:
- requirements: docs/requirements.txt
4 changes: 4 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sphinx
sphinx_rtd_theme
sphinx-autodoc
sphinx-napoleon

0 comments on commit 6ec126f

Please sign in to comment.