From 2c66dbc7365e9d529534acf730464a7569fb735d Mon Sep 17 00:00:00 2001 From: Mikhail Klementev Date: Thu, 22 Feb 2024 12:37:11 +0000 Subject: [PATCH] docs: add .readthedocs.yaml --- .github/workflows/e2e.yml | 3 +++ .github/workflows/ubuntu.yml | 4 +++- .readthedocs.yaml | 12 ++++++++++++ README.md | 4 ++-- docs/conf.py | 1 + 5 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/conf.py diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index 0fefc6c..4206e8b 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -8,6 +8,9 @@ on: - ".github/workflows/ubuntu.yml" - ".github/workflows/macos.yml" - ".github/workflows/debian-cache.yml" + - "docs/**" + - ".readthedocs.yaml" + - "README.md" concurrency: group: ${{ github.workflow_ref }} diff --git a/.github/workflows/ubuntu.yml b/.github/workflows/ubuntu.yml index 3596917..1658a8e 100644 --- a/.github/workflows/ubuntu.yml +++ b/.github/workflows/ubuntu.yml @@ -5,9 +5,11 @@ on: push: paths-ignore: - ".github/workflows/images-*" - - ".github/workflows/debian-cache.yml" - ".github/workflows/e2e.yml" + - ".github/workflows/macos.yml" + - ".github/workflows/debian-cache.yml" - "docs/**" + - ".readthedocs.yaml" - "README.md" pull_request: diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..8342102 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,12 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: latest + +sphinx: + configuration: docs/conf.py + +formats: + - pdf diff --git a/README.md b/README.md index eb0ee1a..a5b3dd1 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/aba4aad2046b4d1a9a99cf98e22c018b)](https://app.codacy.com/app/jollheef/out-of-tree?utm_source=github.com&utm_medium=referral&utm_content=jollheef/out-of-tree&utm_campaign=Badge_Grade_Dashboard) -[![Go Report Card](https://goreportcard.com/badge/code.dumpstack.io/tools/out-of-tree)](https://goreportcard.com/report/code.dumpstack.io/tools/out-of-tree) +[![Ubuntu](https://github.com/out-of-tree/out-of-tree/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/out-of-tree/out-of-tree/actions/workflows/ubuntu.yml) +[![E2E](https://github.com/out-of-tree/out-of-tree/actions/workflows/e2e.yml/badge.svg)](https://github.com/out-of-tree/out-of-tree/actions/workflows/e2e.yml) [![Documentation Status](https://readthedocs.org/projects/out-of-tree/badge/?version=latest)](https://out-of-tree.readthedocs.io/en/latest/?badge=latest) # [out-of-tree](https://out-of-tree.io) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..f37adaf --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ +project = "out-of-tree"