Skip to content

Commit 68415c4

Browse files
Merge pull request #4 from pnnl-int/simplify-docs
remove some docs
2 parents fd4d48d + 8a72e80 commit 68415c4

2 files changed

Lines changed: 2 additions & 23 deletions

File tree

docs_site/index.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# COMcheck API - Python Client
22

3-
Type-safe Python client for the U.S. Department of Energy's [COMcheck Web API](https://becp-dev.pnl.gov/) for building energy code compliance verification.
3+
Type-safe Python client for the PNNL's [COMcheck Web](https://comcheck.energycode.pnl.gov/) for building energy code compliance verification.
44

55
## Features
66

77
- **Type-safe** --- Pydantic models for all API inputs and outputs
8-
- **Full CRUD** --- Create, read, update, and delete projects and components
98
- **Envelope management** --- Roofs, walls, floors, windows, doors, skylights, and thermal bridges
109
- **Compliance simulation** --- Start simulations and retrieve results programmatically
1110
- **Validation** --- JSON schema validation and Pydantic type checking at every boundary
@@ -49,9 +48,4 @@ uv add comcheck_api
4948
| Module | Description |
5049
|--------|-------------|
5150
| [`comcheck_api.client`](api/client.md) | High-level client interface |
52-
| [`comcheck_api.api`](api/api-service.md) | Low-level HTTP service layer |
53-
| [`comcheck_api.types`](api/types/api-types.md) | Pydantic models for requests/responses |
54-
| [`comcheck_api.managers`](api/managers/data-manager.md) | Data managers for components |
55-
| [`comcheck_api.project_operations`](api/operations/building-area.md) | Project manipulation functions |
56-
| [`comcheck_api.utilities`](api/utilities/defaults.md) | Helper functions and defaults |
57-
| [`comcheck_api.exceptions`](api/exceptions.md) | Custom exception hierarchy |
51+
| [`comcheck_api.project_operations`](api/operations/building-area.md) | [Building area](api/operations/building-area.md) and [envelope](api/operations/envelope.md) operations |

mkdocs.yml

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,10 @@ nav:
5959
- Getting Started: getting-started.md
6060
- API Reference:
6161
- Client: api/client.md
62-
- API Service: api/api-service.md
63-
- Types:
64-
- API Types: api/types/api-types.md
65-
- Common Types: api/types/common-types.md
66-
- Custom Base Model: api/types/custom-base-model.md
67-
- Managers:
68-
- Data Manager: api/managers/data-manager.md
69-
- Building Area: api/managers/building-area.md
70-
- Envelope Components: api/managers/envelope.md
7162
- Project Operations:
7263
- Building Area Operations: api/operations/building-area.md
7364
- Envelope Operations: api/operations/envelope.md
74-
- Utilities:
75-
- Project Defaults: api/utilities/defaults.md
76-
- Export & Helpers: api/utilities/common.md
77-
- Envelope Utilities: api/utilities/envelope.md
78-
- ID Registry: api/utilities/id-registry.md
7965
- Constants:
8066
- Project Template: api/constants/common.md
8167
- Building Area Defaults: api/constants/building-area.md
8268
- Envelope Defaults: api/constants/envelope.md
83-
- Exceptions: api/exceptions.md

0 commit comments

Comments
 (0)