Skip to content

Commit

Permalink
lint + doc.yml & readthedocs.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
norlandrhagen committed Mar 17, 2024
1 parent dd4e1be commit 350d806
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 18 deletions.
23 changes: 23 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "mambaforge-4.10"

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

# Optionally declare the Python requirements required to build your docs
conda:
environment: ci/doc.yml
python:
install:
- method: pip
path: .
15 changes: 15 additions & 0 deletions ci/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: virtualizarr-docs
channels:
- conda-forge
- nodefaults
dependencies:
- python>=3.9
- "sphinx"
- "pydata_sphinx_theme"
- "sphinx-autodoc-typehints"
- "sphinx_copybutton"
- "sphinx_togglebutton"
- "sphinx_design"
- "myst_nb"
- pip:
- -e ..
14 changes: 0 additions & 14 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ dynamic = ["version"]
dependencies = [
"xarray",
"kerchunk",
"ujson",
"pydantic",
"packaging",
]
Expand All @@ -35,22 +34,9 @@ test = [
"pytest",
]

docs = [
"sphinx",
"pydata_sphinx_theme",
"sphinx-autodoc-typehints",
"sphinx_copybutton",
"sphinx_togglebutton",
"sphinx_design",
"myst_nb"
]



[project.optional-dependencies]
test = [
"pytest"
]

[project.urls]
Home = "https://github.com/TomNicholas/VirtualiZarr"
Expand Down
6 changes: 2 additions & 4 deletions virtualizarr/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
from .manifests import ManifestArray # type: ignore # noqa
from .xarray import ( # type: ignore # noqa
VirtualiZarrDatasetAccessor,
open_dataset_via_kerchunk,
)
from .xarray import VirtualiZarrDatasetAccessor # type: ignore # noqa
from .xarray import open_dataset_via_kerchunk # noqa: F401

0 comments on commit 350d806

Please sign in to comment.