.readthedocs.yml

version: 2

# Important: we need to disable all unneeded formats.
# Note that HTML and JSON are always built: https://docs.readthedocs.io/en/latest/yaml-config.html#formats
# Especially, the 'htmlzip' format takes a LOT of memory and causes the build to fail - see our issue #1472:
# https://github.com/aiidateam/aiida-core/issues/1472
formats: []

# Set the version of Python and other tools you might need
build:
  apt_packages:
    - graphviz
  os: ubuntu-22.04
  tools:
    python: "3.11"
  jobs:
    pre_build:
      - for lang in $(ls translations); do mkdir -p aiida-core/docs/source/locales/${lang}; done
      - for lang in $(ls translations); do ln -s -r translations/${lang} aiida-core/docs/source/locales/${lang}/LC_MESSAGES; done

# Need to install the package itself such that the entry points are installed and the API doc can build properly
python:
    install:
        - method: pip
          path: aiida-core
          extra_requirements:
            - docs
            - tests
            - rest
            - atomic_tools

# Let the build fail if there are any warnings
sphinx:
    builder: html
    fail_on_warning: true

search:
  ranking:
    reference/apidoc/*: -7

submodules:
  include: all