From 623c150e2aa6a01a7496700d3a1ec58593fcacc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franz=20Kir=C3=A1ly?= Date: Fri, 20 Sep 2024 19:22:32 +0100 Subject: [PATCH 1/4] Update .readthedocs.yml --- .readthedocs.yml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 82fc2f91..3ccfba15 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -19,8 +19,11 @@ sphinx: formats: - htmlzip +build: + os: ubuntu-22.04 + # Optionally set the version of Python and requirements required to build your docs python: - version: 3.11 + version: 3.12 install: - requirements: docs/requirements.txt From 491462a04586d5dc25dc45cf858d1e7506b48ce9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franz=20Kir=C3=A1ly?= Date: Fri, 20 Sep 2024 19:34:21 +0100 Subject: [PATCH 2/4] [MNT] Add `build` config in `readthedocs.yml` --- .readthedocs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index 3ccfba15..3fe3ed82 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -21,6 +21,8 @@ formats: build: os: ubuntu-22.04 + tools: + python: "3.12" # Optionally set the version of Python and requirements required to build your docs python: From 94f9897735a541096098eba971a0df146bec3a3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franz=20Kir=C3=A1ly?= Date: Fri, 20 Sep 2024 19:51:19 +0100 Subject: [PATCH 3/4] [MNT] fixes to `readthedocs.yml` (#1676) Fixes `readthedocs.yml`, closes #1675 --- .readthedocs.yml | 7 ++++--- pyproject.toml | 11 +++++++++++ 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 3fe3ed82..c633039a 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -24,8 +24,9 @@ build: tools: python: "3.12" -# Optionally set the version of Python and requirements required to build your docs python: - version: 3.12 install: - - requirements: docs/requirements.txt + - method: pip + path: . + extra_requirements: + - docs diff --git a/pyproject.toml b/pyproject.toml index 7bcb0096..3e52005c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -133,6 +133,17 @@ dev = [ "pandoc>=2.3,<3.0.0", ] +# docs - dependencies for building the documentation +docs = [ + "sphinx>3.2", + "pydata-sphinx-theme", + "nbsphinx", + "pandoc", + "nbconvert", + "recommonmark", + "docutils", +] + github-actions = ["pytest-github-actions-annotate-failures"] [tool.setuptools.packages.find] From 94a2467221d974be3f9dc0acbac76d09a9cb92d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franz=20Kir=C3=A1ly?= Date: Fri, 20 Sep 2024 20:14:21 +0100 Subject: [PATCH 4/4] [MNT] updates references in CI and doc locations to `main` (#1677) This updates references to the main branch in CI and doc locations to `main` --- .github/workflows/lint.yml | 4 ++-- .github/workflows/test.yml | 4 ++-- README.md | 6 +++--- docs/source/conf.py | 2 +- docs/source/tutorials.rst | 2 +- pytorch_forecasting/data/examples.py | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index f05e5211..9b91811b 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -2,9 +2,9 @@ name: Lint on: push: - branches: [master] + branches: [main] pull_request: - branches: [master] + branches: [main] jobs: pre-commit-hooks: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c424361c..2a39eb2d 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -5,9 +5,9 @@ name: Test on: push: - branches: [master] + branches: [main] pull_request: - branches: [master] + branches: [main] concurrency: group: ${{ github.workflow }}-${{ github.ref }} diff --git a/README.md b/README.md index cf4a356e..17794bf6 100755 --- a/README.md +++ b/README.md @@ -5,13 +5,13 @@ _PyTorch Forecasting_ is a PyTorch-based package for forecasting with state-of-t | | **[Documentation](https://pytorch-forecasting.readthedocs.io)** · **[Tutorials](https://pytorch-forecasting.readthedocs.io/en/latest/tutorials.html)** · **[Release Notes](https://pytorch-forecasting.readthedocs.io/en/latest/CHANGELOG.html)** | |---|---| -| **Open Source** | [![MIT](https://img.shields.io/github/license/jdb78/pytorch-forecasting)](https://github.com/jdb78/pytorch-forecasting/blob/master/LICENSE) | +| **Open Source** | [![MIT](https://img.shields.io/github/license/jdb78/pytorch-forecasting)](https://github.com/jdb78/pytorch-forecasting/blob/main/LICENSE) | | **Community** | [![!discord](https://img.shields.io/static/v1?logo=discord&label=discord&message=chat&color=lightgreen)](https://discord.com/invite/54ACzaFsn7) [![!slack](https://img.shields.io/static/v1?logo=linkedin&label=LinkedIn&message=news&color=lightblue)](https://www.linkedin.com/company/scikit-time/) | | **CI/CD** | [![github-actions](https://img.shields.io/github/actions/workflow/status/jdb78/pytorch-forecasting/pypi_release.yml?logo=github)](https://github.com/jdb78/pytorch-forecasting/actions/workflows/pypi_release.yml) [![readthedocs](https://img.shields.io/readthedocs/pytorch-forecasting?logo=readthedocs)](https://pytorch-forecasting.readthedocs.io) [![platform](https://img.shields.io/conda/pn/conda-forge/pytorch-forecasting)](https://github.com/jdb78/pytorch-forecasting) [![Code Coverage][coverage-image]][coverage-url] | | **Code** | [![!pypi](https://img.shields.io/pypi/v/pytorch-forecasting?color=orange)](https://pypi.org/project/pytorch-forecasting/) [![!conda](https://img.shields.io/conda/vn/conda-forge/pytorch-forecasting)](https://anaconda.org/conda-forge/pytorch-forecasting) [![!python-versions](https://img.shields.io/pypi/pyversions/pytorch-forecasting)](https://www.python.org/) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) | -[coverage-image]: https://codecov.io/gh/jdb78/pytorch-forecasting/branch/master/graph/badge.svg -[coverage-url]: https://codecov.io/github/jdb78/pytorch-forecasting?branch=master +[coverage-image]: https://codecov.io/gh/jdb78/pytorch-forecasting/branch/main/graph/badge.svg +[coverage-url]: https://codecov.io/github/jdb78/pytorch-forecasting?branch=main --- diff --git a/docs/source/conf.py b/docs/source/conf.py index 60128395..afce813c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,7 +2,7 @@ # # This file only contains a selection of the most common options. For a full # list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html +# https://www.sphinx-doc.org/en/main/usage/configuration.html # -- Path setup -------------------------------------------------------------- diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index d85a2c23..c8282719 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -3,7 +3,7 @@ Tutorials .. _tutorials: -The following tutorials can be also found as `notebooks on GitHub `_. +The following tutorials can be also found as `notebooks on GitHub `_. .. toctree:: :titlesonly: diff --git a/pytorch_forecasting/data/examples.py b/pytorch_forecasting/data/examples.py index 03ae566a..79b7cb52 100644 --- a/pytorch_forecasting/data/examples.py +++ b/pytorch_forecasting/data/examples.py @@ -8,7 +8,7 @@ import numpy as np import pandas as pd -BASE_URL = "https://github.com/jdb78/pytorch-forecasting/raw/master/examples/data/" +BASE_URL = "https://github.com/sktime/pytorch-forecasting/raw/main/examples/data/" DATA_PATH = Path(__file__).parent