Skip to content

Commit

Permalink
Merge pull request #167 from choderalab/feat/use_RTD_for_docs
Browse files Browse the repository at this point in the history
Use rtd for docs
  • Loading branch information
yuanqing-wang authored Jul 13, 2023
2 parents 5619889 + 2d383eb commit 2e92ecb
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 42 deletions.
33 changes: 0 additions & 33 deletions .github/workflows/sphinx.yml

This file was deleted.

19 changes: 19 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
version: 2

build:
os: "ubuntu-20.04"
tools:
python: "mambaforge-4.10"

sphinx:
configuration: docs/conf.py
fail_on_warning: false

conda:
environment: devtools/conda-envs/espaloma.yaml

python:
# Install our python package before building the docs
install:
- method: pip
path: .
11 changes: 2 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,10 @@
# Incase the project was not installed
import os
import sys
import subprocess

sys.path.insert(0, os.path.abspath('..'))

import espaloma
from espaloma import mm, nn, graphs, data

# download experiments
import os
os.system("bash download_experiments.sh")

# -- Project information -----------------------------------------------------

project = 'espaloma'
Expand All @@ -37,7 +31,6 @@
# The full version, including alpha/beta/rc tags
release = ''


# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
Expand Down Expand Up @@ -81,7 +74,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down

0 comments on commit 2e92ecb

Please sign in to comment.