Skip to content

Commit 19ef39d

Browse files
authored
Merge pull request #189 from luxonis/docker-compose-hotfix
Update docker-compose.yml
2 parents 9e21b38 + 339f9b0 commit 19ef39d

File tree

2 files changed

+43
-40
lines changed

2 files changed

+43
-40
lines changed

README.md

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,6 @@ Python bindings for C++ depthai-core library
1010

1111
Documentation is available over at [Luxonis DepthAI API](https://docs.luxonis.com/projects/api/en/latest/)
1212

13-
### Building documentation
14-
15-
- **Using [Docker](https://docs.docker.com/) (with [Docker Compose](https://docs.docker.com/compose/install/))**
16-
17-
```
18-
cd docs
19-
docker-compose build
20-
docker-compose up
21-
```
22-
23-
Then open [http://localhost:8000](http://localhost:8000).
24-
25-
This docker container will watch changes in the `docs/source` directory and rebuild the docs automatically
26-
27-
- **Linux**
28-
29-
First, please install the required [dependencies](#Dependencies)
30-
31-
Then run the following commands to build the docs website
32-
33-
```
34-
python3 -m pip install -U pip
35-
python3 -m pip install -r docs/requirements.txt
36-
cmake -S . -B build -D DEPTHAI_BUILD_DOCS=ON -D DEPTHAI_PYTHON_BUILD_DOCS=ON
37-
cmake --build build --target sphinx --parallel
38-
python3 -m http.server --bind 0.0.0.0 8000 --directory build/docs/sphinx
39-
```
40-
41-
Then open [http://localhost:8000](http://localhost:8000).
42-
43-
This will build documentation based on current sources, so if some new changes will be made, run this command
44-
in a new terminal window to update the website source
45-
46-
```
47-
cmake --build build --target sphinx --parallel
48-
```
49-
50-
Then refresh your page - it should load the updated website that was just built
51-
52-
5313
## Installation
5414

5515
Prebuilt wheels are available in [Luxonis repository](https://artifacts.luxonis.com/artifactory/luxonis-python-snapshot-local/)
@@ -108,6 +68,48 @@ ctest
10868
- Raspbian 10;
10969
- macOS 10.14.6, 10.15.4;
11070

71+
72+
### Building documentation
73+
74+
- **Using [Docker](https://docs.docker.com/) (with [Docker Compose](https://docs.docker.com/compose/install/))**
75+
76+
```
77+
cd docs
78+
sudo docker-compose build
79+
sudo docker-compose up
80+
```
81+
82+
> ℹ️ You can leave out the `sudo` if you have added your user to the `docker` group (or are using rootless docker).
83+
84+
Then open [http://localhost:8000](http://localhost:8000).
85+
86+
This docker container will watch changes in the `docs/source` directory and rebuild the docs automatically
87+
88+
- **Linux**
89+
90+
First, please install the required [dependencies](#Dependencies)
91+
92+
Then run the following commands to build the docs website
93+
94+
```
95+
python3 -m pip install -U pip
96+
python3 -m pip install -r docs/requirements.txt
97+
cmake -S . -B build -D DEPTHAI_BUILD_DOCS=ON -D DEPTHAI_PYTHON_BUILD_DOCS=ON
98+
cmake --build build --parallel --target sphinx
99+
python3 -m http.server --bind 0.0.0.0 8000 --directory build/docs/sphinx
100+
```
101+
102+
Then open [http://localhost:8000](http://localhost:8000).
103+
104+
This will build documentation based on current sources, so if some new changes will be made, run this command
105+
in a new terminal window to update the website source
106+
107+
```
108+
cmake --build build --parallel --target sphinx
109+
```
110+
111+
Then refresh your page - it should load the updated website that was just built
112+
111113
## Troubleshooting
112114
113115
### Relocation link error

docs/docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
version: "3"
12
services:
23
docs:
34
build:

0 commit comments

Comments
 (0)