Merge branch 'main' into update-URL

.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:

.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 }}

.readthedocs.yml

@@ -19,8 +19,14 @@ sphinx:
 formats:
   - htmlzip
 
-# Optionally set the version of Python and requirements required to build your docs
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
 python:
-  version: 3.11
   install:
-    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -10,8 +10,8 @@ _PyTorch Forecasting_ is a PyTorch-based package for forecasting with state-of-t
 | **CI/CD** | [![github-actions](https://img.shields.io/github/actions/workflow/status/sktime/pytorch-forecasting/pypi_release.yml?logo=github)](https://github.com/sktime/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/sktime/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/sktime/pytorch-forecasting/branch/master/graph/badge.svg
-[coverage-url]: https://codecov.io/github/sktime/pytorch-forecasting?branch=master
+[coverage-image]: https://codecov.io/gh/sktime/pytorch-forecasting/branch/main/graph/badge.svg
+[coverage-url]: https://codecov.io/github/sktime/pytorch-forecasting?branch=main
 
 ---
 

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 --------------------------------------------------------------
 

docs/source/tutorials.rst

@@ -3,7 +3,7 @@ Tutorials
 
 .. _tutorials:
 
-The following tutorials can be also found as `notebooks on GitHub <https://github.com/sktime/pytorch-forecasting/tree/master/docs/source/tutorials>`_.
+The following tutorials can be also found as `notebooks on GitHub <https://github.com/sktime/pytorch-forecasting/tree/main/docs/source/tutorials>`_.
 
 .. toctree::
    :titlesonly:

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]

pytorch_forecasting/data/examples.py

@@ -8,7 +8,7 @@
 import numpy as np
 import pandas as pd
 
-BASE_URL = "https://github.com/sktime/pytorch-forecasting/raw/master/examples/data/"
+BASE_URL = "https://github.com/sktime/pytorch-forecasting/raw/main/examples/data/"
 
 DATA_PATH = Path(__file__).parent