README.md from the project template: overview, requirements, setup with a local .venv and python -m pip install --upgrade pip, run, tests, AGPL license and links
Documents building the API docs with doxygen Doxyfile
Checks
doxygen Doxyfile builds without warnings from an empty docs/doxygen/
A clean copy of the project (no .git, .env or venv) was set up following only the README: pip upgrade, pip install -e ".[dev]", 13 tests passed, python -m calc and calc ran correctly
## Summary
MIL-004 Documentation and release:
- `README.md` from the project template: overview, requirements, setup with a local `.venv` and `python -m pip install --upgrade pip`, run, tests, AGPL license and links
- Documents building the API docs with `doxygen Doxyfile`
## Checks
- `doxygen Doxyfile` builds without warnings from an empty `docs/doxygen/`
- A clean copy of the project (no `.git`, `.env` or venv) was set up following only the README: pip upgrade, `pip install -e ".[dev]"`, 13 tests passed, `python -m calc` and `calc` ran correctly
Closes #26
Closes #27
Closes #28
MIL-004 Documentation and release.
- Write README.md from the project template: overview, requirements,
setup with a local .venv and pip upgrade, run, tests, AGPL license
and links
- Document building the API docs with doxygen Doxyfile
- Verified: doxygen builds without warnings, and a clean copy installs,
runs and passes the 13 tests following only the README
Closes#26Closes#27Closes#28
Task: MIL-004#1
Task: MIL-004#2
Task: MIL-004#3
Tirsvad
merged commit afdffdf564 into main2026-10-04 15:10:19 +02:00
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Summary
MIL-004 Documentation and release:
README.mdfrom the project template: overview, requirements, setup with a local.venvandpython -m pip install --upgrade pip, run, tests, AGPL license and linksdoxygen DoxyfileChecks
doxygen Doxyfilebuilds without warnings from an emptydocs/doxygen/.git,.envor venv) was set up following only the README: pip upgrade,pip install -e ".[dev]", 13 tests passed,python -m calcandcalcran correctlyCloses #26
Closes #27
Closes #28