Skip to content

Commit 91c2c40

Browse files
authored
Merge branch 'main' into feat/updates-20250721
2 parents 5c199e2 + 76f4ffa commit 91c2c40

File tree

6 files changed

+53
-2799
lines changed

6 files changed

+53
-2799
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ The format is (loosely) based on [Keep a Changelog](http://keepachangelog.com/)
66

77
## Unreleased
88

9+
### Updated
10+
11+
- Updated stac-validator dependency to v3.10.1 ([#140](https://github.com/stac-utils/stac-check/pull/140))
12+
13+
### Removed
14+
15+
- Removed pdoc-generated documentation files and references as the project now uses Sphinx exclusively for documentation. ([#141](https://github.com/stac-utils/stac-check/pull/141))
16+
917
## [v1.11.0] - 2025-06-22
1018

1119
### Added

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ The intent of this project is to provide a validation tool that also follows the
3737
- [Using HTTP Headers](#using-http-headers)
3838
- [STAC API Validation](#stac-api-validation)
3939
- [Development](#development)
40+
- [Building Documentation](#building-documentation)
4041
- [Sponsors and Supporters](#sponsors-and-supporters)
4142
- [Contributing](#contributing)
4243
- [How to Contribute](#how-to-contribute)
@@ -48,26 +49,7 @@ The intent of this project is to provide a validation tool that also follows the
4849

4950
The documentation is hosted on GitHub Pages at [stac-utils.github.io/stac-check](https://stac-utils.github.io/stac-check/).
5051

51-
### Building Documentation Locally
52-
53-
To build the documentation locally:
54-
55-
```bash
56-
# Install the package with documentation dependencies
57-
pip install -e ".[docs]"
58-
59-
# Build the documentation
60-
make docs
61-
```
62-
63-
The built documentation will be available in the `docs/_build/html` directory.
64-
65-
Alternatively, you can build the documentation using Docker:
66-
67-
```bash
68-
# Build the Docker image and documentation
69-
make docker-docs
70-
```
52+
For development and building the documentation locally, see the [Development](#development) section below.
7153

7254
## Installation
7355

@@ -508,12 +490,38 @@ This object has 5 collections
508490

509491
## Development
510492

511-
Create local docs in the /docs folder:
493+
### Building Documentation
494+
495+
Documentation is automatically built and published to GitHub Pages on every push to the `main` branch. You can view the latest version at [stac-utils.github.io/stac-check](https://stac-utils.github.io/stac-check/).
496+
497+
To build the documentation locally (for development or testing), you'll need to install the development dependencies first:
512498

513499
```bash
514-
$ pdoc --output-dir pdoc ./stac_check
500+
# Install the package with documentation dependencies
501+
pip install -e ".[docs]"
502+
503+
# Build the documentation
504+
make docs
505+
506+
# Open the built documentation
507+
xdg-open docs/_build/html/index.html # On Linux
508+
open docs/_build/html/index.html # On macOS
509+
start docs/_build/html/index.html # On Windows
515510
```
516511

512+
Or using Docker:
513+
514+
```bash
515+
# Build the Docker image and documentation
516+
make docker-docs
517+
```
518+
519+
The documentation is built using Sphinx with the following extensions:
520+
- `sphinx.ext.autodoc` for API documentation
521+
- `sphinx_click` for CLI documentation
522+
- `sphinx_rtd_theme` for the ReadTheDocs theme
523+
- `myst_parser` for Markdown support
524+
517525
## Sponsors and Supporters
518526

519527
The following organizations have contributed time and/or funding to support the development of this project:

0 commit comments

Comments
 (0)