Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix settings reference in runtime docs #1109

Merged
merged 13 commits into from
Apr 20, 2023
7 changes: 4 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ sphinx:
formats:
- pdf

# Optionally set the version of Python and requirements required to build your docs
# Optionally set the version of Python and requirements required to build your
# docs
python:
version: 3.8
install:
- method: pip
path: .
- requirements: docs/requirements.txt
- requirements: requirements/rtd.txt
- requirements: runtimes/alibi-detect/requirements/dev.txt
1 change: 0 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@ start:
sphinx-autobuild . ./_build/html

install-dev:
pip install -e ../
pip install -r ./requirements.txt
14 changes: 14 additions & 0 deletions requirements/rtd.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# NOTE: This requirements.txt file is required to set up our RTD environment.
# Therefore, it follows a couple weird conventions that are required by RTD
# which also make it hard to use locally (thus why it's split in two
# requirements.txt files).
# For example, it must be called from the top-level folder to # align with how
# RTD works (except for `-r` lines, which get converted to relative on-the-fly
# by RTD).

.
# NOTE: Both the Alibi-Detect and Huggingface runtimes show a generated
# reference of the available settings - therefore, they need to be
# available on the environment.
./runtimes/alibi-detect
./runtimes/huggingface