-
Notifications
You must be signed in to change notification settings - Fork 4
/
.readthedocs.yaml
57 lines (50 loc) · 1.71 KB
/
.readthedocs.yaml
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
# 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-20.04
tools:
# python: "mambaforge-22.9"
python: "3.7"
commands:
# - pip install torch==1.12.1+cu116 --extra-index-url https://download.pytorch.org/whl/cu116
# - pip install torch-scatter==2.1.0+pt112cu116 -f https://data.pyg.org/whl/torch-1.12.1+cu116.html
# - pip install .[docs]
# - cd docs/ && make html
# - mkdir _readthedocs
# - cp -r docs/build/html _readthedocs/
# - python setup.py install
# Install dependencies
# - cd docs/ && pip install -r requirements.txt
# Build the site
# - cd docs/ && make html
# Copy generated files into Read the Docs directory
# - cd docs/ && ls
# - cd docs/build && ls
# - mkdir _readthedocs
# - cp --recursive docs/build/html _readthedocs/
- ls _readthedocs
# conda:
# environment: environment.yml
# Build documentation in the "docs/" directory with Sphinx
# sphinx:
# configuration: null
# 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:
# - pdf
# - epub
# 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:
# - method: pip
# path: .
# extra_requirements:
# - docs