Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): add .readthedocs.yaml #34

Merged
merged 24 commits into from
Jul 26, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: update rtd config
  • Loading branch information
Benjamin-eecs committed Jul 20, 2022
commit a2d1e1b73c536327f3de6a47aa810e747e7ec4b2
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ build:
tools:
python: "miniconda3-4.7"
conda:
environment: conda-recipe.yaml
environment: docs/env.yml
formats:
- pdf
sphinx:
Expand Down
63 changes: 63 additions & 0 deletions docs/env.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Copyright 2022 MetaOPT Team. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: torchopt

channels:
- pytorch
- defaults
- nvidia/label/cuda-11.6.2
- nvidia
- conda-forge

dependencies:
- python = 3.8
- pip

# Learning
- pytorch::pytorch = 1.12
- pytorch::pytorch-mutex = *=*cuda*
- pip:
- sphinxcontrib-katex # for documentation
- jax
- jaxlib >= 0.3

# Device select
- nvidia::cudatoolkit = 11.6
- cudnn

# Build toolkit
- cmake >= 3.4
- make
- cxx-compiler
- gxx = 10
- nvidia/label/cuda-11.6.2::cuda-nvcc
- nvidia/label/cuda-11.6.2::cuda-cudart-dev
- pybind11

# Misc
- typing-extensions

# Documentation
- sphinx
- sphinx_rtd_theme
- sphinx-autobuild
- sphinx-copybutton
- sphinxcontrib-spelling
- sphinxcontrib-bibtex
- sphinx-autodoc-typehints
- myst-nb
- ipykernel
- pandoc
- docutils