You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Always run `make lint` after code changes — runs taplo, isort, black, ruff, and mypy
14
+
* Never edit `readme.md` directly — it is generated from `docs/index.md` via `make docs`
15
+
* To run all tests use `make test` — runs all tests in the `tests/` directory using pytest
16
+
* To run a specific test file, use `uv run pytest tests/path/to/test_file.py`
17
+
18
+
19
+
## Documentation
20
+
21
+
* The documentation for ccy is available at `https://ccy.quantmid.com`
22
+
* Documentation is built using [mkdocs](https://www.mkdocs.org/) and stored in the `docs/` directory. The documentation source files are written in markdown format.
23
+
* Do not use em dashes (—) in documentation files or docstrings. Use colons, parentheses, or restructure the sentence instead.
0 commit comments