Skip to content

Commit 2341802

Browse files
committed
CI: save site build as an artifact
Makes the site downloadable for previewing locally.
1 parent a427887 commit 2341802

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

.github/workflows/ci.yml

+9
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,15 @@ jobs:
139139
run: rsync -az --delete doc/build/html/ docs@${{ secrets.server_ip }}:/usr/share/nginx/pandas/pandas-docs/dev
140140
if: github.event_name == 'push'
141141

142+
- name: Move docs into site directory
143+
run: mv doc/build/html web/build/docs
144+
- name: Save website as an artifact
145+
uses: actions/upload-artifact@v2
146+
with:
147+
name: website
148+
path: web/build
149+
retention-days: 14
150+
142151
data_manager:
143152
name: Test experimental data manager
144153
runs-on: ubuntu-latest

doc/source/development/contributing.rst

+11
Original file line numberDiff line numberDiff line change
@@ -629,6 +629,17 @@ the documentation are also built by Travis-CI. These docs are then hosted `here
629629
<https://pandas.pydata.org/docs/dev/>`__, see also
630630
the :ref:`Continuous Integration <contributing.ci>` section.
631631

632+
Previewing changes
633+
------------------
634+
635+
Once, the pull request is submitted, GitHub Actions will automatically build the
636+
documentation. To view the built site:
637+
638+
#. Wait for the ``CI / Web and docs`` check to complete.
639+
#. Click ``Details`` next to it.
640+
#. From the ``Artifacts`` drop-down, click ``docs`` or ``website`` to download
641+
the site as a ZIP file.
642+
632643
.. _contributing.code:
633644

634645
Contributing to the code base

0 commit comments

Comments
 (0)