From 4b3345b868776f84f10b4caffe05887c7a1abe30 Mon Sep 17 00:00:00 2001 From: Emlyn Davies Date: Thu, 31 Aug 2023 10:28:20 +0200 Subject: [PATCH] Update .readthedocs.yaml (#132) * Update .readthedocs.yaml * Update requirements.txt --- .readthedocs.yaml | 11 ++++++----- docs/_config.yml | 1 + docs/environment.yml | 28 ---------------------------- docs/requirements.txt | 12 ++++++++++++ pyopia/__init__.py | 2 +- requirements.txt | 7 +++++++ 6 files changed, 27 insertions(+), 34 deletions(-) delete mode 100644 docs/environment.yml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c085576a..4a6e2d0a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,8 +5,10 @@ # Required version: 2 -conda: - environment: docs/environment.yml +build: + os: "ubuntu-22.04" + tools: + python: "3.10" # Build documentation in the docs/ directory with Sphinx sphinx: @@ -20,10 +22,9 @@ sphinx: # Optionally set the version of Python and requirements required to build your docs python: - version: 3.8 install: - - method: pip - path: . + - requirements: docs/requirements.txt + - path: . # By default readthedocs does not checkout git submodules submodules: diff --git a/docs/_config.yml b/docs/_config.yml index 67160b3e..a39008ab 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -37,5 +37,6 @@ sphinx: - 'sphinx.ext.autodoc' - 'sphinx.ext.napoleon' - 'sphinx.ext.autosummary' + - 'sphinx.ext.sphinx_togglebutton' config: autosummary_generate: True \ No newline at end of file diff --git a/docs/environment.yml b/docs/environment.yml deleted file mode 100644 index ff1f6d33..00000000 --- a/docs/environment.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: pyopia -channels: - - conda-forge -dependencies: # These are the conda packages - - python=3.10 - - pip - - flake8 - - numpy>=1.20.1 - - pandas - - h5py - - pytables=3.6.1 - - scipy - - scikit-image - - pytest>=7.2.0 - - imageio - - pip: # The following packages are installed with pip - - docopt - - tqdm - - setuptools - - pytest-error-for-skips - - sphinx_rtd_theme>=0.5.0 - - sphinxcontrib-napoleon>=0.7 - - tensorflow-cpu==2.10.1 - - numpy==1.23.4 - - ipykernel>=6.19.4 - - gdown - - cmocean - - jupyter-book diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..0bbe1ceb --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,12 @@ + flake8 + docopt + setuptools + pytest-error-for-skips + sphinx_rtd_theme>=0.5.0 + sphinxcontrib-napoleon>=0.7 + sphinx-togglebutton + sphinx-copybutton + readthedocs-sphinx-search + myst-nb + jupyter_book + ipykernel>=6.19.4 diff --git a/pyopia/__init__.py b/pyopia/__init__.py index f31e7249..03de9806 100644 --- a/pyopia/__init__.py +++ b/pyopia/__init__.py @@ -1 +1 @@ -__version__ = '0.0.57' +__version__ = '0.0.58' diff --git a/requirements.txt b/requirements.txt index 54b5a289..b1c58a9a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,8 +11,15 @@ tqdm setuptools pytest-error-for-skips + nbclient==0.7 + sphinx==5.0 sphinx_rtd_theme>=0.5.0 sphinxcontrib-napoleon>=0.7 + sphinx-togglebutton + sphinx-copybutton + readthedocs-sphinx-search + myst-nb + jupyter_book tensorflow-cpu==2.10.1 ipykernel>=6.19.4 urllib3<2.0