From 41f8477f07c4068bbf58126f180c335f5f04b1e5 Mon Sep 17 00:00:00 2001 From: Pablo Casares Crespo Date: Fri, 5 Jan 2024 13:05:02 +0100 Subject: [PATCH 1/4] Migrate readthedocs to version 2 --- .readthedocs.yaml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000000..b4a77fee31 --- /dev/null +++ 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: . \ No newline at end of file From 0351c80c67d1dcecce163e41909dcbde1ac41560 Mon Sep 17 00:00:00 2001 From: Pablo Casares Date: Fri, 5 Jan 2024 13:42:54 +0100 Subject: [PATCH 2/4] Update .readthedocs.yaml Co-authored-by: Honnix --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b4a77fee31..15a3b126a1 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -15,4 +15,4 @@ formats: python: install: - method: pip - path: . \ No newline at end of file + path: . From e581a53fffbf320a79ef60f171e8f15d6f954341 Mon Sep 17 00:00:00 2001 From: Pablo Casares Crespo Date: Fri, 5 Jan 2024 16:40:47 +0100 Subject: [PATCH 3/4] Trigger readthedocs build From c1a0f4d0dd21f5e97c34264e9981ef6d0a170694 Mon Sep 17 00:00:00 2001 From: Pablo Casares Crespo Date: Fri, 5 Jan 2024 17:01:29 +0100 Subject: [PATCH 4/4] Add documentation badge in README --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 102388157b..1114085d27 100644 --- 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.