RTD theme fix (#1122)

* pip sphinx-rtd-theme

* Bump sphinx

* Add extension

* Add docs/requirements.txt

* CL
This commit is contained in:
Stéphane Bruckert 2024-05-28 09:08:23 +01:00 committed by GitHub
parent 2d1cb99be7
commit 1ce8c4f06b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 11 additions and 7 deletions

View File

@ -10,3 +10,7 @@ build:
sphinx: sphinx:
configuration: docs/conf.py configuration: docs/conf.py
python:
install:
- requirements: docs/requirements.txt

View File

@ -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 extra installation step to TUTORIAL.md for required installation packages.
- Added Troubleshooting Tips section to TUTORIAL.md to address common installation issues. - Added Troubleshooting Tips section to TUTORIAL.md to address common installation issues.
- Added link to Spotipy Tutorial for Beginners under Getting Started. - Added link to Spotipy Tutorial for Beginners under Getting Started.
- Readthedocs config
### Changed ### Changed
- Changes the YouTube video link for authentication tutorial (the old video was in low definition, the new one is in high definition) - 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
- Fixed unused description parameter in playlist creation example - Fixed unused description parameter in playlist creation example
- Readthedocs
### Changed ### Changed
- Drop support for EOL Python 3.7. - Drop support for EOL Python 3.7.

View File

@ -26,7 +26,10 @@ sys.path.insert(0, os.path.abspath('.'))
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # 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. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

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' 'mock==2.0.0'
] ]
doc_reqs = [
'Sphinx>=1.5.2'
]
extra_reqs = { extra_reqs = {
'doc': doc_reqs,
'test': test_reqs 'test': test_reqs
} }