From 2341802f5db80689a550f67977836ab39db0e66e Mon Sep 17 00:00:00 2001 From: Aidan Feldman Date: Mon, 25 Jan 2021 01:07:37 -0500 Subject: [PATCH] CI: save site build as an artifact Makes the site downloadable for previewing locally. --- .github/workflows/ci.yml | 9 +++++++++ doc/source/development/contributing.rst | 11 +++++++++++ 2 files changed, 20 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b551e7ded0178..6f8ad708fa858 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -139,6 +139,15 @@ jobs: run: rsync -az --delete doc/build/html/ docs@${{ secrets.server_ip }}:/usr/share/nginx/pandas/pandas-docs/dev if: github.event_name == 'push' + - name: Move docs into site directory + run: mv doc/build/html web/build/docs + - name: Save website as an artifact + uses: actions/upload-artifact@v2 + with: + name: website + path: web/build + retention-days: 14 + data_manager: name: Test experimental data manager runs-on: ubuntu-latest diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 90ecee8cf9312..bf1d7d5fce32a 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -629,6 +629,17 @@ the documentation are also built by Travis-CI. These docs are then hosted `here `__, see also the :ref:`Continuous Integration ` section. +Previewing changes +------------------ + +Once, the pull request is submitted, GitHub Actions will automatically build the +documentation. To view the built site: + +#. Wait for the ``CI / Web and docs`` check to complete. +#. Click ``Details`` next to it. +#. From the ``Artifacts`` drop-down, click ``docs`` or ``website`` to download + the site as a ZIP file. + .. _contributing.code: Contributing to the code base