Skip to content

Commit

Permalink
Update RTD configuration. (#75)
Browse files Browse the repository at this point in the history
RTD is removing the "use system packages" feature on 29 Aug 2023.
This PR ensures that our docs will sill build.
  • Loading branch information
gpleiss authored Aug 25, 2023
1 parent d7b1988 commit ad59b8c
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 21 deletions.
9 changes: 7 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ build:
tools:
python: "3.8"
jobs:
pre_install: # Lock version of torch at 1.11
- pip install torch==1.11.0+cpu -f https://download.pytorch.org/whl/torch_stable.html
pre_build:
- python -m setuptools_scm
- python -m setuptools_scm # Get correct version number

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand All @@ -26,4 +28,7 @@ sphinx:
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ linting, testing, and building the documentation, run the following:
```bash
git clone https://github.com/cornellius-gp/linear_operator.git
cd linear_operator
pip install -e .[dev,test]
pip install -r docs/requirements.txt
pip install -e ".[dev,docs,test]"
pre-commit install
```

Expand Down
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,14 +394,7 @@ If you are contributing a pull request, it is best to perform a manual installat
```sh
git clone https://github.com/cornellius-gp/linear_operator.git
cd linear_operator
pip install -e .[dev,test]
```

To generate the documentation locally, you will also need to run the following command
from the linear_operator folder:

```sh
pip install -r docs/requirements.txt
pip install -e ".[dev,docs,test]"
```


Expand Down
8 changes: 0 additions & 8 deletions docs/requirements.txt

This file was deleted.

11 changes: 10 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,16 @@ def find_version(*file_paths):
python_requires=">=3.8",
install_requires=install_requires,
extras_require={
"dev": ["ufmt", "twine", "pre-commit"],
"dev": ["pre-commit", "setuptools_scm", "ufmt", "twine"],
"docs": [
"myst-parser",
"setuptools_scm",
"sphinx",
"six",
"sphinx_rtd_theme",
"sphinx-autodoc-typehints",
"uncompyle6",
],
"test": ["flake8==5.0.4", "flake8-print==5.0.0", "pytest"],
},
test_suite="test",
Expand Down

0 comments on commit ad59b8c

Please sign in to comment.