pytorch-lightning

1
# Copyright The Lightning AI team.
2
#
3
# Licensed under the Apache License, Version 2.0 (the "License");
4
# you may not use this file except in compliance with the License.
5
# You may obtain a copy of the License at
6
#
7
#     http://www.apache.org/licenses/LICENSE-2.0
8
#
9
# Unless required by applicable law or agreed to in writing, software
10
# distributed under the License is distributed on an "AS IS" BASIS,
11
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
# See the License for the specific language governing permissions and
13
# limitations under the License.
14

15
# .readthedocs.yml
16
# Read the Docs configuration file
17
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
18

19
# Required
20
version: 2
21

22
submodules:
23
  include: all
24
  recursive: true
25

26
# Build documentation in the docs/ directory with Sphinx
27
# reference: https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx
28
sphinx:
29
  fail_on_warning: true
30

31
build:
32
  os: ubuntu-20.04
33
  tools:
34
    python: "3.9"
35
  apt_packages:
36
    - texlive-latex-extra
37
    - dvipng
38
    - texlive-pictures
39
  commands:
40
    - printenv
41
    - pwd ; ls -lh
42
    - pip install -U pip awscli py-tree --user
43
    - python -m awscli s3 sync --no-sign-request s3://sphinx-packages/ dist/ ; ls -lh dist/
44
    - >
45
      pip install -e ".[app]" -q -r _notebooks/.actions/requires.txt \
46
          -r requirements/app/docs.txt \
47
          -r requirements/fabric/docs.txt \
48
          -r requirements/pytorch/docs.txt \
49
          -f 'https://download.pytorch.org/whl/cpu/torch_stable.html' -f dist/ ;
50
      pip list
51
    # this need to be split so `sphinx-build` is picked from previous installation
52
    - bash docs/rtfd-build.sh
53
    - cd docs/build ; python -m py_tree --depth_limit=1
54
    - mkdir -p _readthedocs ; mv docs/build _readthedocs/html
55