Skip to content

Commit 58890e9

Browse files
authored
ARROW-85 Add linkcheck to CI (#79)
1 parent f2bf0f9 commit 58890e9

File tree

3 files changed

+40
-3
lines changed

3 files changed

+40
-3
lines changed

.github/workflows/test-python.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,38 @@ jobs:
7979
run: |
8080
pip install check-manifest
8181
check-manifest -v
82+
83+
docs:
84+
runs-on: ubuntu-latest
85+
steps:
86+
- uses: actions/checkout@v2
87+
- name: Cache conda
88+
uses: actions/cache@v2
89+
env:
90+
# Increase this value to reset cache if environment.yml has not changed
91+
CACHE_NUMBER: 0
92+
with:
93+
path: ~/conda_pkgs_dir
94+
key:
95+
${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{
96+
hashFiles('bindings/python/docs/environment.yml') }}
97+
- uses: conda-incubator/setup-miniconda@v2
98+
with:
99+
auto-update-conda: true
100+
activate-environment: mongo_arrow_documentation
101+
environment-file: bindings/python/docs/environment.yml
102+
use-only-tar-bz2: true # IMPORTANT: This needs to be set for caching to work properly!
103+
- name: Install lib
104+
shell: bash -l {0}
105+
run: |
106+
pip install .
107+
- name: Build docs with warnings
108+
shell: bash -l {0}
109+
run: |
110+
pushd docs
111+
make html SPHINXOPTS="-W"
112+
- name: Run linkcheck
113+
shell: bash -l {0}
114+
run: |
115+
pushd docs
116+
make linkcheck

bindings/python/docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ know to use **PyMongoArrow**.
3030
Getting Help
3131
------------
3232
If you're having trouble or have questions about PyMongoArrow, ask your question on
33-
our `MongoDB Community Forum <https://developer.mongodb.com/community/forums/tags/c/drivers-odms-connectors/7/python-driver>`_.
33+
our `MongoDB Community Forum <https://www.mongodb.com/community/forums/tag/python>`_.
3434
Once you get an answer, it'd be great if you could work it back into this
3535
documentation and contribute!
3636

bindings/python/docs/source/installation.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,10 @@ To upgrade using pip::
3030

3131
$ python -m pip install --upgrade pymongoarrow
3232

33-
.. attention:: If the install fails due to an error like ``ValueError: Could not find "libbson-1.0" library`` it means that ``pip`` failed to find a
34-
suitable wheel for your platform. We recommend first ensuring you have ``pip`` >= 20.3 installed. To upgrade ``pip`` run::
33+
.. attention:: If the install fails due to an error like ``ValueError: Could
34+
not find "libbson-1.0" library`` it means that ``pip`` failed to find a
35+
suitable wheel for your platform. We recommend first ensuring you have
36+
``pip`` >= 20.3 installed. To upgrade ``pip`` run::
3537

3638
$ python -m pip install --upgrade pip
3739

0 commit comments

Comments
 (0)