Compare commits

...

2 Commits

Author SHA1 Message Date
Stéphane Bruckert
fa00f8c3b2
Create .readthedocs.yaml 2024-05-28 09:49:32 +01:00
Stephane Bruckert
f4e7f826d1 Fix RTD 2024-05-28 09:13:19 +01:00
4 changed files with 23 additions and 8 deletions

16
.readthedocs.yaml Normal file
View File

@ -0,0 +1,16 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.12"
sphinx:
configuration: docs/conf.py
python:
install:
- requirements: docs/requirements.txt

View File

@ -11,7 +11,6 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
import spotipy
import sys
import os
@ -28,7 +27,10 @@ sys.path.insert(0, os.path.abspath('.'))
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc']
extensions = [
'sphinx.ext.autodoc',
'sphinx_rtd_theme'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -94,7 +96,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

2
docs/requirements.txt Normal file
View File

@ -0,0 +1,2 @@
Sphinx~=7.3.7
sphinx-rtd-theme~=2.0.0

View File

@ -7,12 +7,7 @@ test_reqs = [
'mock==2.0.0'
]
doc_reqs = [
'Sphinx>=1.5.2'
]
extra_reqs = {
'doc': doc_reqs,
'test': test_reqs
}