Skip to content

Commit 390bee7

Browse files
authored
ci: remove documentation generation and deployment support (#288)
* ci: remove `deploy.yaml` workflow Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com> * ci: remove `generate-docs` job from the `build` workflow Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com> * build: remove support for generating API documentation Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com> --------- Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>
1 parent ebbf2a3 commit 390bee7

6 files changed

Lines changed: 3 additions & 679 deletions

File tree

.github/workflows/build.yaml

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -38,32 +38,3 @@ jobs:
3838
uses: actions/upload-artifact@v4.6.2
3939
with:
4040
path: dist/*
41-
42-
generate-docs:
43-
name: Generate Documentation
44-
runs-on: ubuntu-22.04
45-
steps:
46-
- name: Checkout
47-
uses: actions/checkout@v4.2.2
48-
49-
- name: Setup Python
50-
uses: actions/setup-python@v5.6.0
51-
with:
52-
python-version: 3.11
53-
54-
- name: Setup Poetry
55-
uses: threeal/setup-poetry-action@v1.2.0
56-
57-
- name: Cache Dependencies
58-
id: cache-deps
59-
uses: actions/cache@v4.2.3
60-
with:
61-
key: poetry-${{ runner.os }}-${{ hashFiles('pyproject.toml') }}
62-
path: .venv
63-
64-
- name: Install Dependencies
65-
if: steps.cache-deps.outputs.cache-hit != 'true'
66-
run: poetry install --with dev
67-
68-
- name: Generate Documentation
69-
run: poetry run poe docs

.github/workflows/deploy.yaml

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

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,4 @@
33

44
*.egg-info
55
__pycache__
6-
apidocs
76
dist

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ The Python Starter is a [GitHub repository template](https://docs.github.com/en/
88
- Project and dependency management with [Poetry](https://python-poetry.org/), supplemented by [Poe the Poet](https://poethepoet.natn.io/index.html) for task management.
99
- Code formatting and linting with [Ruff](https://github.com/astral-sh/ruff), leveraging all recommended rules for enhanced code quality.
1010
- Testing framework powered by [Pytest](https://docs.pytest.org/en/7.4.x/), complete with support for test coverage checks.
11-
- API documentation generation with [pydoctor](https://pydoctor.readthedocs.io/en/latest/index.html) and automated deployment to [GitHub Pages](https://pages.github.com/).
1211
- [GitHub Actions](https://github.com/features/actions) support with multiple workflows for continuous integration (CI) and continuous delivery (CD).
1312
- Automated dependency update checks with [Dependabot](https://docs.github.com/en/code-security/dependabot).
1413

0 commit comments

Comments
 (0)