forked from aboutcircles/circles-contracts-v2
-
Notifications
You must be signed in to change notification settings - Fork 1
/
.readthedocs.yaml
34 lines (28 loc) · 951 Bytes
/
.readthedocs.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# .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 OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.12"
nodejs: "19"
rust: "1.64"
apt_packages:
- solc
# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/source/conf.py
# Declare the Python requirements required to build your documentation
python:
install:
- requirements: docs/requirements.txt
# Additional commands to set up the environment for Foundry
commands:
- curl -L https://foundry.paradigm.xyz | bash # Install Foundry
- foundryup # Update Foundry
- forge install # Install dependencies for Foundry project
- ./generate_solidity_docs.sh # Generate Solidity documentation
- sphinx-build -b html docs/source docs/build/html # Build Sphinx documentation