Skip to content

Commit

Permalink
updated readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
selimfirat committed Oct 6, 2023
1 parent 33cd645 commit be42b91
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 2 deletions.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# 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.8"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

# 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:
- requirements: requirements-dev.txt
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
exec(open(version_path).read())

project = 'PySAD'
copyright = '2020, Selim Firat Yilmaz'
copyright = '2023, Selim Firat Yilmaz'
author = 'Selim Firat Yilmaz'

version = __version__
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
sphinx_rtd_theme==0.5.0
sphinx==3.1.2
sphinx==6.2.1
sphinxcontrib-fulltoc==1.2.0
pytest==5.2.1
pytest-cov==2.10.0
Expand Down

0 comments on commit be42b91

Please sign in to comment.