Skip to content

Commit 947863e

Browse files
authored
chore!: remove MkDocs documentation generation feature (#46)
Remove all MkDocs-based documentation infrastructure from the project. This simplifies the project by eliminating the documentation build system that was generating GitHub Pages documentation from example files. Changes include: - Remove mkdocs.yml configuration file - Remove scripts/build_docs.py documentation builder script - Remove .github/workflows/docs.yml CI workflow for deploying docs - Remove docs optional dependency group from pyproject.toml (mkdocs-terminal, pygments, pymdown-extensions) - Remove docs-serve and docs-build targets from justfile - Update CLAUDE.md to remove documentation command references The uv.lock file is updated to reflect the removed dependencies. BREAKING CHANGE: The `docs` optional dependency group and related commands (`make docs-serve`, `make docs-build`) are no longer available.
1 parent bcb12b4 commit 947863e

File tree

7 files changed

+8
-407
lines changed

7 files changed

+8
-407
lines changed

.github/workflows/docs.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.

CLAUDE.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ make mypy # Run type checking
2929
make test # Run all tests
3030
make test-tools # Run tool-specific tests
3131
make test-examples # Run example tests
32-
33-
# Documentation
34-
make docs-serve # Build and serve docs locally (http://localhost:8000)
35-
make docs-build # Build docs for deployment
3632
```
3733

3834
## Code Architecture
@@ -113,9 +109,3 @@ toolset = StackOneToolSet(
113109
- Core execution logic in `StackOneTool.execute()` method
114110
- HTTP configuration via `ExecuteConfig` class
115111
- Response handling in `_process_response()`
116-
117-
### Updating Documentation
118-
119-
- Examples requirements: See @./.cursor/rules/examples-standards
120-
- Run `make docs-serve` to preview changes
121-
- MkDocs config in `mkdocs.yml`

justfile

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,3 @@ test-examples:
2525
# Run type checking
2626
mypy:
2727
uv run mypy stackone_ai
28-
29-
# Build and serve docs locally
30-
docs-serve:
31-
uv run scripts/build_docs.py
32-
uv run mkdocs serve
33-
34-
# Build docs for deployment
35-
docs-build:
36-
uv run scripts/build_docs.py
37-
uv run mkdocs build

mkdocs.yml

Lines changed: 0 additions & 51 deletions
This file was deleted.

pyproject.toml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,6 @@ examples = [
5454
"openai>=1.63.2",
5555
"python-dotenv>=1.0.1",
5656
]
57-
docs = [
58-
"mkdocs-terminal>=4.7.0",
59-
"pygments>=2.12",
60-
"pymdown-extensions"
61-
]
6257

6358
[dependency-groups]
6459
dev = [

scripts/build_docs.py

Lines changed: 0 additions & 82 deletions
This file was deleted.

0 commit comments

Comments
 (0)