OpenROAD/.readthedocs.yaml

# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

submodules:
    include:
      - src/sta

# Set the OS, Python version and other tools you might need
build:
  os: ubuntu-22.04
  apt_packages:
    - libasound2
    - graphviz
  tools:
    python: "3.10"
    nodejs: "16"
  jobs:
    post_install:
      - npm install -g @mermaid-js/mermaid-cli

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/conf.py

formats:
  - pdf

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
   install:
   - requirements: docs/requirements.txt