Skip to content

Commit 0f162c2

Browse files
committed
πŸ“ docs: remove any mention of API from the docs
1 parent a878497 commit 0f162c2

5 files changed

Lines changed: 6 additions & 6 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ make setup-dev
116116
make setup-cli
117117

118118
# 5. Run quality & tests
119-
make check-all # runs all checks: lint, types, docs build, API, etc.
119+
make check-all # runs all checks: lint, types, docs build, etc.
120120
```
121121

122122
**Stay up to date**

β€Ždocs/features/overview.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ python-template-uv generates a fully configured Python project with modern tooli
1414

1515
## Infrastructure
1616

17-
- **[Documentation](documentation.md)** -- MkDocs with Material theme, auto-generated API docs, GitHub Pages deployment
17+
- **[Documentation](documentation.md)** -- MkDocs with Material theme, auto-generated docs, GitHub Pages deployment
1818
- **[Docker](docker.md)** -- Production Dockerfile, compose files, development overrides, optional GPU support
1919
- **[CI/CD](ci-cd.md)** -- GitHub Actions workflows for testing, releasing, docs, and dependency updates
2020

β€Ždocs/index.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Scaffold production-ready Python packages and applications in seconds with [Copi
8484

8585
---
8686

87-
MkDocs with Material theme pre-configured. Auto-generated API docs with mkdocstrings. Deploy to GitHub Pages with one command.
87+
MkDocs with Material theme pre-configured. Auto-generated docs with mkdocstrings. Deploy to GitHub Pages with one command.
8888

8989
[:octicons-arrow-right-24: Documentation](features/documentation.md)
9090

β€Žtemplate/README.md.jinjaβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
- **Task Runner:** `mise` for consistent cross-platform tasks
3535
- **Quality:** Ruff (lint + format), Mypy (type-checking), pre-commit hooks
3636
- **Testing:** pytest{%- if tox %}, Tox (multi-version){%- endif %}{%- if pytest_xdist %}, parallel test execution{%- endif %}
37-
- **Documentation:** MkDocs with Material theme, auto-generated API docs
37+
- **Documentation:** MkDocs with Material theme, auto-generated docs
3838
{%- if with_typer_cli %}
3939
- **CLI:** Typer-based command-line interface (`{{ cli_name }}`)
4040
{%- endif %}

β€Žtemplate/docs/development/contributing.md.jinjaβ€Ž

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,11 @@ Examples:
7474
{% if cz_gitmoji -%}
7575
✨ feat: add new feature
7676
πŸ› fix: resolve bug in parser
77-
πŸ“ docs: update API documentation
77+
πŸ“ docs: update documentation
7878
{%- else -%}
7979
feat: add new feature
8080
fix: resolve bug in parser
81-
docs: update API documentation
81+
docs: update documentation
8282
{%- endif %}
8383
```
8484

0 commit comments

Comments
Β (0)