docs: pin dependencies to fix build error

try out furo theme
This commit is contained in:
Eric Wasylishen 2023-05-06 12:43:23 -06:00
parent b994bb750d
commit f9ad83aed5
4 changed files with 82 additions and 4 deletions

15
.readthedocs.yaml Normal file
View File

@ -0,0 +1,15 @@
version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.11"
# Build from the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# Explicitly set the version of Python and its requirements
python:
install:
- requirements: docs/requirements.txt

View File

@ -42,9 +42,9 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = 'furo'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ['_static']

2
docs/requirements.in Normal file
View File

@ -0,0 +1,2 @@
sphinx==6.2.1
furo==2023.3.27

View File

@ -1,2 +1,63 @@
sphinx==5.1.1
sphinx_rtd_theme==1.0.0
#
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile requirements.in
#
alabaster==0.7.13
# via sphinx
babel==2.12.1
# via sphinx
beautifulsoup4==4.12.2
# via furo
certifi==2022.12.7
# via requests
charset-normalizer==3.1.0
# via requests
colorama==0.4.6
# via sphinx
docutils==0.19
# via sphinx
furo==2023.3.27
# via -r requirements.in
idna==3.4
# via requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.2
# via sphinx
markupsafe==2.1.2
# via jinja2
packaging==23.1
# via sphinx
pygments==2.15.1
# via
# furo
# sphinx
requests==2.30.0
# via sphinx
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.4.1
# via beautifulsoup4
sphinx==6.2.1
# via
# -r requirements.in
# furo
# sphinx-basic-ng
sphinx-basic-ng==1.0.0b1
# via furo
sphinxcontrib-applehelp==1.0.4
# via sphinx
sphinxcontrib-devhelp==1.0.2
# via sphinx
sphinxcontrib-htmlhelp==2.0.1
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.3
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
# via sphinx
urllib3==2.0.2
# via requests