From b8ae6d63fe2012b72b21404680687887061b6592 Mon Sep 17 00:00:00 2001 From: Cody Baker <51133164+CodyCBakerPhD@users.noreply.github.com> Date: Thu, 26 Sep 2024 02:06:04 -0400 Subject: [PATCH] Move RTD files (#515) * Delete requirements-rtd.txt * Delete .readthedocs.yaml * Update doc-link-checks.yml * Update .readthedocs.yaml * h5py version pin * syntax --- .github/workflows/doc-link-checks.yml | 2 +- .readthedocs.yaml | 23 ----------------------- docs/.readthedocs.yaml | 2 +- pyproject.toml | 3 ++- requirements-rtd.txt | 7 ------- 5 files changed, 4 insertions(+), 33 deletions(-) delete mode 100644 .readthedocs.yaml delete mode 100644 requirements-rtd.txt diff --git a/.github/workflows/doc-link-checks.yml b/.github/workflows/doc-link-checks.yml index 6b30d93b0..3aaa4d5d8 100644 --- a/.github/workflows/doc-link-checks.yml +++ b/.github/workflows/doc-link-checks.yml @@ -17,7 +17,7 @@ jobs: python-version: 3.9 - name: Install Sphinx dependencies - run: pip install -r requirements-rtd.txt + run: pip install -r docs/requirements-rtd.txt - name: Install package for API docs run: pip install -e . diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index a0d4dd7b1..000000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,23 +0,0 @@ -# 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: "3.9" - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/conf.py - fail_on_warning: true - -# Python requirements required to build your docs -python: - install: - - requirements: requirements-rtd.txt - - method: pip - path: . diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml index a0d4dd7b1..4864cad6e 100644 --- a/docs/.readthedocs.yaml +++ b/docs/.readthedocs.yaml @@ -18,6 +18,6 @@ sphinx: # Python requirements required to build your docs python: install: - - requirements: requirements-rtd.txt + - requirements: docs/requirements-rtd.txt - method: pip path: . diff --git a/pyproject.toml b/pyproject.toml index afb56999e..826dc8bf2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,7 +45,8 @@ dependencies = [ "click", "tqdm", "isodate", - "numpy>=1.22.0,<2.0.0" # TODO: add compatibility for 2.0 + "numpy>=1.22.0,<2.0.0", # TODO: add compatibility for 2.0 - HDMF Zarr and others also still have some troubles + "h5py<3.12.0", # TODO: remove pin when https://github.com/h5py/h5py/issues/2505 is fixed and released ] [project.optional-dependencies] diff --git a/requirements-rtd.txt b/requirements-rtd.txt deleted file mode 100644 index cf9500d54..000000000 --- a/requirements-rtd.txt +++ /dev/null @@ -1,7 +0,0 @@ -numpy -jsonschema==3.2.0 -Jinja2>=3.1.3 -sphinx==5.1.1 -sphinx_rtd_theme==0.5.1 -readthedocs-sphinx-search==0.3.2 -sphinx-copybutton==0.5.0