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
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ The format is (loosely) based on [Keep a Changelog](http://keepachangelog.com/)

### Updated

- Updated stac-validator dependency to v3.10.1 ([#140](https://github.com/stac-utils/stac-check/pull/140))
- Updated stac-validator dependency to v3.10.1 ([#140](https://github.com/stac-utils/stac-check/pull/140))

### Removed

- 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))

## [v1.11.0] - 2025-06-22

Expand Down
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ The intent of this project is to provide a validation tool that also follows the
- [Using HTTP Headers](#using-http-headers)
- [STAC API Validation](#stac-api-validation)
- [Development](#development)
- [Building Documentation](#building-documentation)
- [Sponsors and Supporters](#sponsors-and-supporters)
- [Contributing](#contributing)
- [How to Contribute](#how-to-contribute)
Expand All @@ -48,26 +49,7 @@ The intent of this project is to provide a validation tool that also follows the

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

### Building Documentation Locally

To build the documentation locally:

```bash
# Install the package with documentation dependencies
pip install -e ".[docs]"

# Build the documentation
make docs
```

The built documentation will be available in the `docs/_build/html` directory.

Alternatively, you can build the documentation using Docker:

```bash
# Build the Docker image and documentation
make docker-docs
```
For development and building the documentation locally, see the [Development](#development) section below.

## Installation

Expand Down Expand Up @@ -508,12 +490,38 @@ This object has 5 collections

## Development

Create local docs in the /docs folder:
### Building Documentation

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/).

To build the documentation locally (for development or testing), you'll need to install the development dependencies first:

```bash
$ pdoc --output-dir pdoc ./stac_check
# Install the package with documentation dependencies
pip install -e ".[docs]"

# Build the documentation
make docs

# Open the built documentation
xdg-open docs/_build/html/index.html # On Linux
open docs/_build/html/index.html # On macOS
start docs/_build/html/index.html # On Windows
```

Or using Docker:

```bash
# Build the Docker image and documentation
make docker-docs
```

The documentation is built using Sphinx with the following extensions:
- `sphinx.ext.autodoc` for API documentation
- `sphinx_click` for CLI documentation
- `sphinx_rtd_theme` for the ReadTheDocs theme
- `myst_parser` for Markdown support

## Sponsors and Supporters

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