Skip to content

Commit 07d5a6e

Browse files
committed
CI: save site+docs builds as artifacts
Makes the downloadable for previewing locally.
1 parent 37b5800 commit 07d5a6e

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

.github/workflows/ci.yml

+13
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,19 @@ jobs:
118118
source activate pandas-dev
119119
doc/make.py --warnings-are-errors | tee sphinx.log ; exit ${PIPESTATUS[0]}
120120
121+
- name: Save website as an artifact
122+
uses: actions/upload-artifact@v2
123+
with:
124+
name: website
125+
path: web/build
126+
retention-days: 14
127+
- name: Save docs as an artifact
128+
uses: actions/upload-artifact@v2
129+
with:
130+
name: docs
131+
path: doc/build/html
132+
retention-days: 14
133+
121134
# This can be removed when the ipython directive fails when there are errors,
122135
# including the `tee sphinx.log` in te previous step (https://github.com/ipython/ipython/issues/11547)
123136
- name: Check ipython directive errors

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)