# .readthedocs.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:
# updated and deployed from Aug 1, 2023
python: "mambaforge-22.9"
jobs:
pre_create_environment:
# update mamba just in case
- mamba update --yes --quiet --name=base mamba 'zstd=1.5.2'
- mamba --version
- mamba list --name=base
post_create_environment:
- conda run -n ${CONDA_DEFAULT_ENV} mamba list
# use conda run executable wrapper to have all env variables
- conda run -n ${CONDA_DEFAULT_ENV} mamba --version
- conda run -n ${CONDA_DEFAULT_ENV} pip install . --no-deps
# Declare the requirements required to build your docs
conda:
environment:
environment.yml
# Build documentation in the doc directory with Sphinx
sphinx:
configuration: doc/sphinx/source/conf.py
fail_on_warning: true
# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
- pdf