Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/workflows/continuous-integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,25 @@ 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 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
run: pip install .
- name: Build docs
run: ./scripts/build-docs

pre-release:
name: pre-release
runs-on: ubuntu-latest
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions requirements-min.txt
Original file line number Diff line number Diff line change
@@ -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