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
Copy file name to clipboardExpand all lines: CHANGELOG.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,14 @@ The format is (loosely) based on [Keep a Changelog](http://keepachangelog.com/)
6
6
7
7
## Unreleased
8
8
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))
-[Sponsors and Supporters](#sponsors-and-supporters)
41
42
-[Contributing](#contributing)
42
43
-[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
48
49
49
50
The documentation is hosted on GitHub Pages at [stac-utils.github.io/stac-check](https://stac-utils.github.io/stac-check/).
50
51
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.
71
53
72
54
## Installation
73
55
@@ -508,12 +490,38 @@ This object has 5 collections
508
490
509
491
## Development
510
492
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:
512
498
513
499
```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
515
510
```
516
511
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
+
517
525
## Sponsors and Supporters
518
526
519
527
The following organizations have contributed time and/or funding to support the development of this project:
0 commit comments