abacus-develop/.readthedocs.yaml at c969a48187cb24ad3fc81db585b10b26f3e72ce6 · deepmodeling/abacus-develop · GitHub

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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# Read the Docs configuration file for Sphinx projects
# 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.11"
  apt_packages:
    - build-essential
    - cmake
    - gfortran
    - git
    - libfftw3-dev
    - liblapack-dev
    - libopenblas-dev
    - ninja-build
    - pkg-config
  jobs:
    pre_build:
      - >
        cmake -S . -B build-rtd-docs -G Ninja
        -DCMAKE_BUILD_TYPE=Release
        -DENABLE_MPI=OFF
        -DENABLE_LCAO=OFF
        -DUSE_OPENMP=OFF
        -DUSE_ELPA=OFF
        -DUSE_CUDA=OFF
        -DUSE_ROCM=OFF
        -DBUILD_TESTING=OFF
        -DENABLE_LIBXC=OFF
        -DENABLE_LIBRI=OFF
        -DENABLE_DFTD4=OFF
        -DENABLE_RAPIDJSON=OFF
        -DENABLE_MLALGO=OFF
        -DENABLE_FLOAT_FFTW=OFF
        -DENABLE_CNPY=OFF
        -DCOMMIT_INFO=OFF
        -DGIT_SUBMODULE=OFF
        -DMKLROOT=OFF
      - cmake --build build-rtd-docs --target abacus_pw_ser --parallel 2

# Build documentation in the "docs/" directory with Sphinx
sphinx:
  configuration: docs/conf.py
  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
  # builder: "dirhtml"
  # Fail on all warnings to avoid broken references
  # fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# 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