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

Fix RTD build #1103

Merged
merged 6 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,14 @@ build:

sphinx:
configuration: docs/conf.py
fail_on_warning: false
# Interchange's docs should not produce warnings; if they start,
# something is broken (most likely automatic API doc generation)
fail_on_warning: true

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

python:
install:
- method: pip
path: .
20 changes: 11 additions & 9 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,8 @@
# Incase the project was not installed
import importlib
import os
import sys

try:
from openff.interchange import __version__
except ModuleNotFoundError:
__version__ = "0.0.0"

sys.path.insert(0, os.path.abspath("../"))

from openff.interchange import __version__

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

Expand Down Expand Up @@ -290,4 +283,13 @@
]


# -- Extension configuration -------------------------------------------------
# -- ReadTheDocs configuration -------------------------------------------------

if os.environ.get("READTHEDOCS", "") == "True":
# Define the canonical URL if you are using a custom domain on Read the Docs
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

# Tell Jinja2 templates the build is running on Read the Docs
if "html_context" not in globals():
html_context = {}
html_context["READTHEDOCS"] = True
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ requires = [
build-backend = "setuptools.build_meta"

[project]
name="Interchange"
name="openff-interchange"
description = "A project (and object) for storing, manipulating, and converting molecular mechanics data."
readme = "README.md"
authors = [{name = "Open Force Field Initiative", email = "[email protected]"}]
Expand Down