mirror of
https://github.com/hwchase17/langchain
synced 2024-10-31 15:20:26 +00:00
6e78dacd78
customize readthedocs config so that we can parallelize the api docs build
33 lines
1.1 KiB
YAML
33 lines
1.1 KiB
YAML
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
# Set the version of Python and other tools you might need
|
|
build:
|
|
os: ubuntu-22.04
|
|
tools:
|
|
python: "3.11"
|
|
commands:
|
|
- python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
|
|
- python -m pip install --upgrade --no-cache-dir pip setuptools
|
|
- python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext
|
|
- python -m pip install --exists-action=w --no-cache-dir -r docs/api_reference/requirements.txt
|
|
- python docs/api_reference/create_api_rst.py
|
|
- cat docs/api_reference/conf.py
|
|
- python -m sphinx -T -E -b html -d _build/doctrees -c docs/api_reference docs/api_reference $READTHEDOCS_OUTPUT/html -j auto
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
sphinx:
|
|
configuration: docs/api_reference/conf.py
|
|
|
|
# If using Sphinx, optionally build your docs in additional formats such as PDF
|
|
# formats:
|
|
# - pdf
|
|
|
|
# Optionally declare the Python requirements required to build your docs
|
|
python:
|
|
install:
|
|
- requirements: docs/api_reference/requirements.txt
|