Skip to content

Commit 22af049

Browse files
authored
Update README.md
1 parent 772a366 commit 22af049

File tree

1 file changed

+42
-40
lines changed

1 file changed

+42
-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-
sudo docker-compose build
20-
sudo 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 --parallel --target sphinx
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 --parallel --target sphinx
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/)
@@ -101,6 +61,48 @@ ctest
10161
- Raspbian 10;
10262
- macOS 10.14.6, 10.15.4;
10363

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

0 commit comments

Comments
 (0)