Merge pull request #3269 from spotify/readthedocs-v2

Migrate readthedocs to version 2
spotify · Jan 5, 2024 · 626e9b7 · 626e9b7
2 parents b5be147 + c1a0f4d
commit 626e9b7
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: doc/conf.py
+
+formats:
+  - pdf
+  - epub
+
+python:
+  install:
+    - method: pip
+      path: .
diff --git a/README.rst b/README.rst
@@ -14,6 +14,10 @@
 .. image:: https://img.shields.io/pypi/l/luigi.svg?style=flat
    :target: https://pypi.python.org/pypi/luigi
 
+.. image:: https://readthedocs.org/projects/luigi/badge/?version=stable
+    :target: https://luigi.readthedocs.io/en/stable/?badge=stable
+    :alt: Documentation Status
+
 Luigi is a Python (3.6, 3.7, 3.8, 3.9, 3.10, 3.11 tested) package that helps you build complex
 pipelines of batch jobs. It handles dependency resolution, workflow management,
 visualization, handling failures, command line integration, and much more.