CI: Docs build preview in each PR (#1494)

* store html artifacts in circle ci * add note to contributing.md
2026-09-10 12:21:57 +08:00 · 2020-04-19 17:07:16 -04:00
parent c71bd73acb
commit 7131685ae3
2 changed files with 6 additions and 0 deletions
@@ -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:
@@ -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