Skip to content

Commit 0a93457

Browse files
committed
Updated instructions for building documentation in README.md
1 parent beacff7 commit 0a93457

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ This system was used to to develop and validate the control system for [a large
3232

3333
The following documentation is provided in this repository:
3434

35-
- **Technical Documentation**: [Sphinx](https://www.sphinx-doc.org) documentation sources in [/docs](docs/). To build the documentation execute the following commands:
35+
- **Technical Documentation**: [Sphinx](https://www.sphinx-doc.org) documentation sources in [/docs](docs/). You can build the HTML version of the documentation with the following commands:
3636

3737
```bash
3838
cd docs
39-
pip install -r requirements.txt
39+
uv venv && uv sync && source .venv/bin/activate
4040
make html
4141
```
4242

43-
> [!NOTE]
43+
> [!NOTE]
4444
> Currently the technical documentation is only provided in Spanish.
4545
4646
- **Electrical Schematics**: [KiCAD](https://www.kicad.org/) electrical schematics in [/schematics](schematics/).

0 commit comments

Comments
 (0)