From 7131685ae3c3fad4b3cc883bd798765b21ee9ca5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adrian=20W=C3=A4lchli?= Date: Sun, 19 Apr 2020 23:07:16 +0200 Subject: [PATCH] CI: Docs build preview in each PR (#1494) * store html artifacts in circle ci * add note to contributing.md --- .circleci/config.yml | 4 ++++ .github/CONTRIBUTING.md | 2 ++ 2 files changed, 6 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 8b014494c8..945db38b54 100755 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -76,6 +76,10 @@ jobs: steps: - checkout - *make_docs + - store_artifacts: + # allows us to preview the generated html pages + path: docs/build/html/ + destination: html Formatting: docker: diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c7df9af637..fbde00f6fa 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -120,6 +120,8 @@ make html ``` and open `docs/build/html/index.html` in your browser. +When you send a PR the continuous integration will run tests and build the docs. You can access a preview of the html pages in the +_Artifacts_ tab in CircleCI when you click on the task named _ci/circleci: Build-Docs_ at the bottom of the PR page. ### Testing