diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 134784f..be0738c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,3 +10,7 @@ build: sphinx: configuration: docs/conf.py + +python: + install: + - requirements: docs/requirements.txt diff --git a/CHANGELOG.md b/CHANGELOG.md index bf7b9e6..e48ee51 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,7 +16,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added extra installation step to TUTORIAL.md for required installation packages. - Added Troubleshooting Tips section to TUTORIAL.md to address common installation issues. - Added link to Spotipy Tutorial for Beginners under Getting Started. -- Readthedocs config ### Changed - Changes the YouTube video link for authentication tutorial (the old video was in low definition, the new one is in high definition) @@ -31,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Fixed unused description parameter in playlist creation example +- Readthedocs ### Changed - Drop support for EOL Python 3.7. diff --git a/docs/conf.py b/docs/conf.py index 7b64c0b..0f78141 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,7 +26,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'] diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..609f7ac --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx~=7.3.7 +sphinx-rtd-theme~=2.0.0 diff --git a/setup.py b/setup.py index 069511a..c7d1752 100644 --- a/setup.py +++ b/setup.py @@ -7,12 +7,7 @@ test_reqs = [ 'mock==2.0.0' ] -doc_reqs = [ - 'Sphinx>=1.5.2' -] - extra_reqs = { - 'doc': doc_reqs, 'test': test_reqs }