readthedocs sample yaml config file

.readthedocs.yaml

build: 
  apt_packages:
    - graphviz
  commands: # When using this option, none of the commands from build.jobs will be executed
    - echo "This is a command"
  jobs:
    post_checkout:
      - echo "This is a post-checkout job"
    pre_system_dependencies:
      - echo "This is a pre-system-dependencies job"
    post_system_dependencies:
      - echo "This is a post-system-dependencies job"
    pre_create_environment:
      - echo "This is a pre-create-environment job"
    post_create_environment:
      - echo "This is a post-create-environment job"
    pre_install:
      - echo "This is a pre-install job"
    post_install:
      - echo "This is a post-install job"
    pre_build:
      - echo "This is a pre-build job"
    post_build:
      - echo "This is a post-build job"
  os: ubuntu-24.04 # ubuntu-20.04 | ubuntu-22.04 | ubuntu-24.04 | ubuntu-lts-latest
  tools:
    # 1.17 | 1.18 | 1.19 | 1.20 | 1.21 | 1.22 | latest
    golang: latest
    # 14 | 16 | 18 | 19 | 20 | latest
    nodejs: latest
    # 3.10 | 3.11 | 3.12 | 3.8 | 3.9 | latest | miniconda3-4.7 | miniconda3-3.12-24.1 | miniconda-latest | mambaforge-4.10 | mambaforge-22.9 | mambaforge-23.11 | mambaforge-latest
    python: "3.12" 
    # 3.3
    ruby: latest
    # 1.55 | 1.61 | 1.64 | 1.70 | 1.75 | 1.78 | latest
    rust: latest
conda: 
  environment: docs/environment.yml

formats: # all | epub | htmlzip | pdf
  - epub
  - htmlzip
  - pdf

mkdocs:
  configuration: docs/mkdocs.yml # Path to the MkDocs configuration file
  fail_on_warning: false

python:
  install:
    - method: pip
      path: .
      extra_requirements: # Used for Conda
        - docs/requirements.txt
    - requirements: docs/requirements.txt # Used for regular virtual environments

search:
  ignore:
    - search.html
    - search/index.html
    - 404.html
    - 404/index.html
  ranking: # Map of patterns to ranks.
    docs/index.md: 1
    docs/install.md: 2
    docs/tutorial.md: 3

sphinx:
  builder: html # html | dirhtml | singlehtml
  configuration: docs/src/conf.py # Path to the Sphinx configuration file
  fail_on_warning: false # Whether to fail on warnings or not

submodules:
  exclude: 
    - docs/exclude.md
  include: 
    - docs/include.md

version: 2