We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 12b6ea6 commit ac0506eCopy full SHA for ac0506e
AGENTS.md
@@ -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
15
+ pip install -e '.[test]'
16
17
+3. Run the tests:
18
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