From 29f12d89ee8c8e9780ed8ced3ee85c5489c22702 Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Wed, 1 Jun 2022 09:36:27 -0400 Subject: [PATCH 1/7] add docs build to ci --- .github/workflows/continuous-integration.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index 2d2c8552..32d34e42 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -61,6 +61,21 @@ jobs: - name: Test run: ./scripts/test + docs: + name: docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v3 + with: + python-version: 3.9 + cache: 'pip' + cache-dependency-path: 'requirements-docs.txt' + - name: Install docs requirements + run: pip install -r requirements-docs.txt + - name: Build docs + run: ./scripts/build-docs + pre-release: name: pre-release runs-on: ubuntu-latest From b73a19d979b16b5b7f5fbbe602f50f92371c30a5 Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Wed, 1 Jun 2022 09:37:48 -0400 Subject: [PATCH 2/7] add docs build to ci --- .github/workflows/continuous-integration.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index 32d34e42..d521c423 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -73,6 +73,8 @@ jobs: cache-dependency-path: 'requirements-docs.txt' - name: Install docs requirements run: pip install -r requirements-docs.txt + - name: Install pystac_client + run: pip install . - name: Build docs run: ./scripts/build-docs From 9f172bd1903b31503638ca70c90a9f60b888bfc0 Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Wed, 1 Jun 2022 09:41:19 -0400 Subject: [PATCH 3/7] add docs build to ci --- .github/workflows/continuous-integration.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index d521c423..d4ccee27 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -71,6 +71,8 @@ jobs: python-version: 3.9 cache: 'pip' cache-dependency-path: 'requirements-docs.txt' + - name: Install pandoc + run: apt-get update && apt-get -y install pandoc - name: Install docs requirements run: pip install -r requirements-docs.txt - name: Install pystac_client From 482550eec34c77cf9a4e793bb5eaf34f0a2070e8 Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Wed, 1 Jun 2022 09:42:04 -0400 Subject: [PATCH 4/7] add docs build to ci --- .github/workflows/continuous-integration.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index d4ccee27..be477928 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -72,7 +72,7 @@ jobs: cache: 'pip' cache-dependency-path: 'requirements-docs.txt' - name: Install pandoc - run: apt-get update && apt-get -y install pandoc + run: sudo apt-get update && sudo apt-get -y install pandoc - name: Install docs requirements run: pip install -r requirements-docs.txt - name: Install pystac_client From cb44bf0e2cc2670b1e2ba5e4a1cc0363cb029bcb Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Wed, 1 Jun 2022 09:45:47 -0400 Subject: [PATCH 5/7] update readme with pandoc install mention --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a9ce2fe..eb5f6f9a 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,8 @@ $ scripts/format $ git commit -a -m 'formatting updates' ``` -To build the documentation, install the documentation requirements, then use the `build-docs` script: +To build the documentation, [install Pandoc](https://pandoc.org/installing.html), install the +Python documentation requirements via pip, then use the `build-docs` script: ```shell $ pip install -r requirements-docs.txt From 6dbf98aba0e7ae6d987896c1cd3b8f472036e3b2 Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Wed, 1 Jun 2022 09:55:36 -0400 Subject: [PATCH 6/7] don't install min requirements --- .github/workflows/continuous-integration.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index be477928..cff595b4 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -52,8 +52,8 @@ jobs: python-version: 3.9 cache: 'pip' cache-dependency-path: 'requirements-min.txt' - - name: Install minimum requirements - run: pip install -r requirements-min.txt +# - name: Install minimum requirements +# run: pip install -r requirements-min.txt - name: Install run: pip install . - name: Install dev requirements From 692308fe9928b437f550ec932b4b7736e2c9af2b Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Wed, 1 Jun 2022 10:04:54 -0400 Subject: [PATCH 7/7] update min requirements to actual min requirements --- .github/workflows/continuous-integration.yml | 4 ++-- requirements-min.txt | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml index cff595b4..be477928 100644 --- a/.github/workflows/continuous-integration.yml +++ b/.github/workflows/continuous-integration.yml @@ -52,8 +52,8 @@ jobs: python-version: 3.9 cache: 'pip' cache-dependency-path: 'requirements-min.txt' -# - name: Install minimum requirements -# run: pip install -r requirements-min.txt + - name: Install minimum requirements + run: pip install -r requirements-min.txt - name: Install run: pip install . - name: Install dev requirements diff --git a/requirements-min.txt b/requirements-min.txt index ba2e206d..4857b999 100644 --- a/requirements-min.txt +++ b/requirements-min.txt @@ -1,4 +1,4 @@ -requests==2.27.1 -pystac==1.2.0 +requests==2.25.0 +pystac==1.4.0 jsonschema==4.5.1 -python-dateutil==2.7.0 +python-dateutil==2.7.0 \ No newline at end of file