You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To avoid running these checks when committing, use `git commit --no-verify`.
93
-
94
-
You can also run the `./scripts/test` script to run unit tests.
95
-
96
-
### Continuous Integration
97
-
98
-
CI will run `pre-commit run --all-files` and `./scripts/test` to check for code quality. If you have a Pull Request that fails CI, make sure to fix any linting, spelling or test issues reported by either of these.
99
-
100
-
### Documentation
101
-
102
-
To build and develop the documentation locally, make sure sphinx is available (which is installed with `requirements-dev.txt`), and use the Makefile in the docs folder:
103
-
104
-
```
105
-
> cd docs
106
-
> make html
107
-
> make livehtml
108
-
```
109
-
110
-
> Note: You will see some warnings along the lines of
111
-
> ```
112
-
> WARNING: duplicate object description of pystac.Collection.id,
113
-
> other instance in api, use :noindex: for one of them
114
-
> ```
115
-
> for some of the
116
-
> classes. This is expected due to [sphinx-doc/sphinx#8664](https://github.com/sphinx-doc/sphinx/issues/8664).
117
-
118
-
Use 'make' without arguments to see a list of available commands.
119
-
120
-
__Note__: `nbsphinx` requires that a local `pystac` is installed; use `pip install -e .`.
0 commit comments