ci(circleci): add build-docs step for check doc building process

astronomer · Nov 8, 2023 · 359dd31 · 359dd31
1 parent bfec609
commit 359dd31
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -53,6 +53,22 @@ jobs:
           name: Run pre-commit hooks
           command: pre-commit run --all-files
 
+  build-docs:
+    description: "Build docs check (the actual publishing is handled by .readthedocs.yaml)"
+    executor:
+      name: docker-executor
+    steps:
+      - checkout
+      - run:
+          name: Install poetry
+          command: python -m pip install poetry
+      - run:
+          name: Install build docs dependency
+          command: python -m poetry install --only=docs,dev
+      - run:
+          name: Run Sphinx
+          command: poetry run inv docs.build
+
 workflows:
   tests:
     jobs:
@@ -64,3 +80,5 @@ workflows:
           <<: *all_branches_and_version_tag
       - precommit:
           <<: *all_branches_and_version_tag
+      - build-docs:
+          <<: *all_branches_and_version_tag
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,3 +1,4 @@
+---
 version: 2
 
 build:

diff --git a/pyproject.toml b/pyproject.toml
@@ -11,7 +11,6 @@ python = "^3.11"
 [tool.poetry.group.dev.dependencies]
 invoke = "^2.2.0"
 
-
 [tool.poetry.group.docs.dependencies]
 sphinx-book-theme = "^1.0.1"
-Original file line number
+Diff line change
@@ -1,3 +1,4 @@
+    ---
     version: 2
     build:
@@ Expand Down @@