Correct the README Continuous integration section
CI / checks (push) Successful in 46s
CI / checks (pull_request) Successful in 49s

The section and the project layout still named .github/workflows/ci.yml and said CI
builds the documentation. The workflow is .gitea/workflows/ci.yml, runs on Gitea
Actions, and runs pytest, ruff and mypy; it has no Doxygen step, so the README now
points to doxygen Doxyfile and says why the file is not under .github/workflows.
This commit is contained in:
2026-10-08 01:34:30 +08:00
parent ca6c9d9f3c
commit 382d799dfe
+4 -2
View File
@@ -117,7 +117,9 @@ mypy
## Continuous integration ## Continuous integration
`.github/workflows/ci.yml` runs on every push to `main` and on every pull request. It is read by both GitHub Actions and Gitea Actions. It sets up Python 3.13, upgrades `pip`, installs the project with its development tools, then runs ruff (lint and format check), mypy, pytest and the Doxygen build. No step opens a turtle window. `.gitea/workflows/ci.yml` runs on Gitea Actions on every push and on every pull request. It sets up Python 3.13, upgrades `pip`, installs the project with its development tools, then runs pytest, ruff (lint and format check) and mypy. It does not build the source documentation: run `doxygen Doxyfile` yourself, as the next section shows. No step opens a turtle window.
The workflow lives in `.gitea/workflows` and not in `.github/workflows`, so GitHub does not run it and pushing to the GitHub mirror needs no workflow permission.
## Build the source documentation ## Build the source documentation
@@ -133,7 +135,7 @@ Open `build/html/index.html` in a browser. Any Doxygen warning fails the build,
```text ```text
. .
├── .github/workflows/ci.yml continuous integration ├── .gitea/workflows/ci.yml continuous integration
├── docs/ project documents: business case, plan, milestones ├── docs/ project documents: business case, plan, milestones
├── src/turtle_challenges/ the package ├── src/turtle_challenges/ the package
│ ├── constants.py every constant of the project │ ├── constants.py every constant of the project