Skip to content

Commit ac0506e

Browse files
authored
AGENTS.md file for Codex
1 parent 12b6ea6 commit ac0506e

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

AGENTS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Repository maintenance notes
2+
3+
This project uses a Python virtual environment for development and tests.
4+
5+
## Setting up a development environment
6+
7+
1. Create and activate a virtual environment:
8+
9+
```bash
10+
python -m venv venv
11+
source venv/bin/activate
12+
```
13+
2. Install the project with its test dependencies:
14+
```bash
15+
pip install -e '.[test]'
16+
```
17+
3. Run the tests:
18+
```bash
19+
pytest
20+
```
21+
22+
## Building the documentation
23+
24+
Run the following commands if you want to build the docs locally:
25+
26+
```bash
27+
cd docs
28+
pip install -r requirements.txt
29+
make html
30+
```

0 commit comments

Comments
 (0)