Skip to content

Commit be9ed9c

Browse files
committed
docs: Reduce "Developing" section to contributing reference
1 parent 99dbd40 commit be9ed9c

File tree

1 file changed

+1
-65
lines changed

1 file changed

+1
-65
lines changed

README.md

Lines changed: 1 addition & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -55,71 +55,7 @@ See the [documentation page](https://pystac.readthedocs.io/en/latest/) for the l
5555

5656
## Developing
5757

58-
To ensure development libraries are installed, install everything in `requirements-dev.txt`:
59-
60-
```
61-
> pip install -r requirements-dev.txt
62-
```
63-
64-
### Unit Tests
65-
66-
Unit tests are in the `tests` folder. To run unit tests, use `unittest`:
67-
68-
```
69-
> python -m unittest discover tests
70-
```
71-
72-
To run linters, code formatters, and test suites all together, use `test`:
73-
74-
```
75-
> ./scripts/test
76-
```
77-
78-
### Code quality checks
79-
80-
PySTAC uses [flake8](http://flake8.pycqa.org/en/latest/) and [Black](https://github.com/psf/black) for code formatting and style checks. To run both:
81-
82-
```
83-
> pre-commit run --all-files
84-
```
85-
86-
To run these automatically when committing files (runs only on the staged files):
87-
88-
```
89-
> pre-commit install --hook-type=pre-commit --overwrite
90-
```
91-
92-
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 .`.
121-
122-
58+
See [contributing docs](docs/contributing.rst)
12359

12460
## Running the quickstart and tutorials
12561

0 commit comments

Comments
 (0)