Skip to content

Commit 852d912

Browse files
committed
Adopt PyPNM-style maintenance clean script and ignore local MkDocs site output
- add tools/maintenance/clean.sh using the same action-based structure and parsing pattern used in PyPNM - support clean.sh --site for MkDocs build output cleanup and --all for broader local artifact cleanup - remove local site/ output with the new maintenance cleaner - add site/ to .gitignore so MkDocs build artifacts are not reintroduced as untracked files - keep cleanup tooling under tools/maintenance with corrected maintenance spelling - 2026-02-22 18:09:29
1 parent 871fd97 commit 852d912

121 files changed

Lines changed: 168 additions & 1041084 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ htmlcov/
2222
# Packaging / build artifacts
2323
build/
2424
dist/
25+
site/
2526
*.egg-info/
2627
.eggs/
2728
pip-wheel-metadata/

docs/postman-import-and-navigation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ Use this guide after installing Postman and cloning the repository.
66

77
In Postman, import the following files:
88

9-
- [`postman/collections/PyPNM.postman_collection.json`](../postman/collections/PyPNM.postman_collection.json)
10-
- [`postman/collections/PyPNM-CMTS.postman_collection.json`](../postman/collections/PyPNM-CMTS.postman_collection.json)
11-
- [`postman/environments/PyPNM Remote Server.postman_environment.json`](../postman/environments/PyPNM%20Remote%20Server.postman_environment.json)
12-
- [`postman/globals/workspace.postman_globals.json`](../postman/globals/workspace.postman_globals.json)
9+
- [`postman/collections/PyPNM.postman_collection.json`](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/collections/PyPNM.postman_collection.json)
10+
- [`postman/collections/PyPNM-CMTS.postman_collection.json`](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/collections/PyPNM-CMTS.postman_collection.json)
11+
- [`postman/environments/PyPNM Remote Server.postman_environment.json`](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/environments/PyPNM%20Remote%20Server.postman_environment.json)
12+
- [`postman/globals/workspace.postman_globals.json`](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/globals/workspace.postman_globals.json)
1313

1414
Recommended import flow:
1515

@@ -44,7 +44,7 @@ Important:
4444

4545
Use a simple health check first:
4646

47-
1. Open [`PyPNM` collection](../postman/collections/PyPNM.postman_collection.json)
47+
1. Open [`PyPNM` collection](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/collections/PyPNM.postman_collection.json)
4848
2. Open `Health` folder
4949
3. Open `Health` request
5050
4. Confirm `pypnm_url` is set
@@ -59,6 +59,6 @@ Use a simple health check first:
5959

6060
## Troubleshooting Import Setup
6161

62-
- If requests fail immediately, confirm `pypnm_url` is set in [Globals (`workspace.postman_globals.json`)](../postman/globals/workspace.postman_globals.json)
63-
- If variables appear unresolved, verify [`workspace.postman_globals.json`](../postman/globals/workspace.postman_globals.json) imported successfully
64-
- If you use the environment value (`base_url`) instead, verify the imported environment [`PyPNM Remote Server.postman_environment.json`](../postman/environments/PyPNM%20Remote%20Server.postman_environment.json) and ensure request URLs in [`PyPNM.postman_collection.json`](../postman/collections/PyPNM.postman_collection.json) were updated from `{{pypnm_url}}`
62+
- If requests fail immediately, confirm `pypnm_url` is set in [Globals (`workspace.postman_globals.json`)](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/globals/workspace.postman_globals.json)
63+
- If variables appear unresolved, verify [`workspace.postman_globals.json`](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/globals/workspace.postman_globals.json) imported successfully
64+
- If you use the environment value (`base_url`) instead, verify the imported environment [`PyPNM Remote Server.postman_environment.json`](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/environments/PyPNM%20Remote%20Server.postman_environment.json) and ensure request URLs in [`PyPNM.postman_collection.json`](https://github.com/PyPNMApps/Postman-PyPNMApps-API/blob/main/postman/collections/PyPNM.postman_collection.json) were updated from `{{pypnm_url}}`

0 commit comments

Comments
 (0)