Skip to content

Commit

Permalink
set up an environment
Browse files Browse the repository at this point in the history
  • Loading branch information
tpike3 committed Jun 8, 2024
1 parent d657427 commit 032c968
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
12 changes: 4 additions & 8 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,15 @@ build:
tools:
python: "3.10"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
fail_on_warning: false

python:
install:
- method: pip
path: .
extra_requirements:
- docs

conda:
environment: docs/source/environment.yml


# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/source/conf.py
fail_on_warning: false
13 changes: 12 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,19 @@ extend-ignore = [
"ISC001", # ruff format asks to disable this feature
]

[project.optional-dependencies]
docs = [
"myst_parser",
"pydata-sphinx-theme",
"jupyterlite-xeus>=0.1.8,<0.2.0",
]

extend-exclude = ["docs", "build"]
[tool.hatch.envs.docs]
features = ["docs"]
[tool.hatch.envs.docs.scripts]
build = "sphinx-build -b html docs/source docs/build/html"
serve = "python -m http.server --directory docs/build/html"
#extend-exclude = ["docs", "build"]

# Hardcode to Python 3.10.
target-version = "py310"

0 comments on commit 032c968

Please sign in to comment.