Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,42 @@

## Build the docs

- Make sure in `docs` directory

```bash
cd docs
```

- Install the dependencies:

```bash
# Install dependencies.
pip install -r ../requirements/docs.txt
```

- Clean the previous build (optional but recommended):

# Build the docs.
```bash
make clean
```

- Generate the HTML documentation:

```bash
make html
```

## Open the docs with your browser

- Serve the documentation locally:

```bash
python -m http.server -d build/html/
```

Launch your browser and open localhost:8000.
This will start a local server at http://localhost:8000. You can now open your browser and view the documentation.

If port 8000 is already in use, you can specify a different port, for example:

```bash
python -m http.server 3000 -d build/html/
```