Skip to content

Commit 3930769

Browse files
authored
Update docs (#386)
**Related Issue(s):** - # **Description:** - Update mkdocs.yml API section to include sfeos_helpers and other new files/ functionality - Reduce logo sizes for documentation page **PR Checklist:** - [x] Code is formatted and linted (run `pre-commit run --all-files`) - [x] Tests pass (run `make test`) - [x] Documentation has been updated to reflect changes, if applicable - [x] Changes are added to the changelog
1 parent ec9461f commit 3930769

File tree

3 files changed

+65
-5
lines changed

3 files changed

+65
-5
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
88

99
## [Unreleased]
1010

11+
### Changed
12+
13+
- Updated mkdocs/ sfeos doucmentation page [#386](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/386)
14+
1115
## [v5.0.0a0] - 2025-05-29
1216

1317
### Added

docs/mkdocs.yml

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,33 +21,57 @@ nav:
2121
- Tips and Tricks: tips-and-tricks.md
2222
- API:
2323
- stac_fastapi.elasticsearch:
24-
- app: api/stac_fastapi/elasticsearch/app.md
2524
- index: api/stac_fastapi/elasticsearch/index.md
25+
- app: api/stac_fastapi/elasticsearch/app.md
2626
- config: api/stac_fastapi/elasticsearch/config.md
2727
- database_logic: api/stac_fastapi/elasticsearch/database_logic.md
28-
- index: api/stac_fastapi/elasticsearch/index.md
2928
- version: api/stac_fastapi/elasticsearch/version.md
3029
- stac_fastapi.opensearch:
31-
- app: api/stac_fastapi/opensearch/app.md
3230
- index: api/stac_fastapi/opensearch/index.md
31+
- app: api/stac_fastapi/opensearch/app.md
3332
- config: api/stac_fastapi/opensearch/config.md
3433
- database_logic: api/stac_fastapi/opensearch/database_logic.md
35-
- index: api/stac_fastapi/opensearch/index.md
3634
- version: api/stac_fastapi/opensearch/version.md
35+
- sfeos_helpers:
36+
- index: api/sfeos_helpers/index.md
37+
- aggregation:
38+
- module: api/sfeos_helpers/aggregation/index.md
39+
- client: api/sfeos_helpers/aggregation/client.md
40+
- format: api/sfeos_helpers/aggregation/format.md
41+
- database:
42+
- module: api/sfeos_helpers/database/index.md
43+
- datetime: api/sfeos_helpers/database/datetime.md
44+
- document: api/sfeos_helpers/database/document.md
45+
- index: api/sfeos_helpers/database/index.md
46+
- mapping: api/sfeos_helpers/database/mapping.md
47+
- query: api/sfeos_helpers/database/query.md
48+
- utils: api/sfeos_helpers/database/utils.md
49+
- filter:
50+
- module: api/sfeos_helpers/filter/index.md
51+
- client: api/sfeos_helpers/filter/client.md
52+
- cql2: api/sfeos_helpers/filter/cql2.md
53+
- transform: api/sfeos_helpers/filter/transform.md
54+
- mappings: api/sfeos_helpers/mappings.md
55+
- version: api/sfeos_helpers/version.md
3756
- stac_fastapi.core:
3857
- index: api/stac_fastapi/core/index.md
3958
- base_database_logic: api/stac_fastapi/core/base_database_logic.md
4059
- base_settings: api/stac_fastapi/core/base_settings.md
60+
- basic_auth: api/stac_fastapi/core/basic_auth.md
4161
- core: api/stac_fastapi/core/core.md
4262
- datetime_utils: api/stac_fastapi/core/datetime_utils.md
4363
- extensions:
4464
- module: api/stac_fastapi/core/extensions/index.md
65+
- aggregation: api/stac_fastapi/core/extensions/aggregation.md
66+
- fields: api/stac_fastapi/core/extensions/fields.md
4567
- filter: api/stac_fastapi/core/extensions/filter.md
4668
- query: api/stac_fastapi/core/extensions/query.md
4769
- models:
4870
- module: api/stac_fastapi/core/models/index.md
4971
- links: api/stac_fastapi/core/models/links.md
5072
- search: api/stac_fastapi/core/models/search.md
73+
- rate_limit: api/stac_fastapi/core/rate_limit.md
74+
- route_dependencies: api/stac_fastapi/core/route_dependencies.md
5175
- serializers: api/stac_fastapi/core/serializers.md
5276
- session: api/stac_fastapi/core/session.md
5377
- utilities: api/stac_fastapi/core/utilities.md

docs/src/stylesheets/extra.css

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
11
:root {
22
--md-primary-fg-color: rgb(13, 118, 160);
3-
}
3+
}
4+
5+
/* Control the size of the main logo */
6+
img[src*="sfeos.png"] {
7+
max-width: 100%;
8+
height: auto;
9+
width: auto !important;
10+
max-height: 200px;
11+
}
12+
13+
/* Control the size of sponsor logos */
14+
img[src*="logo"], img[src*="VITO.png"] {
15+
max-height: 60px !important;
16+
width: auto !important;
17+
height: auto !important;
18+
}
19+
20+
/* Control the size of technology logos */
21+
img[src*="STAC-01.png"],
22+
img[src*="python.png"],
23+
img[src*="fastapi.svg"],
24+
img[src*="elasticsearch.png"],
25+
img[src*="opensearch.svg"] {
26+
max-height: 50px !important;
27+
width: auto !important;
28+
height: auto !important;
29+
}
30+
31+
/* Make sure all images are responsive and don't overflow */
32+
img {
33+
max-width: 100%;
34+
height: auto;
35+
}

0 commit comments

Comments
 (0)