From 6fae24be6a12514b31fa5fa48725312c783f6563 Mon Sep 17 00:00:00 2001 From: Erik Date: Wed, 31 Mar 2021 17:50:40 +0200 Subject: [PATCH 1/5] Update docker-compose.yml specified version for docker-compose --- docs/docker-compose.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docker-compose.yml b/docs/docker-compose.yml index e2f450637..dc27094a3 100644 --- a/docs/docker-compose.yml +++ b/docs/docker-compose.yml @@ -1,3 +1,4 @@ +version: "3" services: docs: build: From 772a3665c526d0e371a9977d1f72a8f6eb5b7611 Mon Sep 17 00:00:00 2001 From: Erik Date: Fri, 2 Apr 2021 09:53:22 +0200 Subject: [PATCH 2/5] Update README.md when I install via apt (version 1.25.0), I get an error "ERROR: Couldn't connect to Docker daemon at http+docker://localhost - is it running?". Running docker-compose with sudo fixes it --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7d9d8ee94..4e28b7c77 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ Documentation is available over at [Luxonis DepthAI API](https://docs.luxonis.co ``` cd docs - docker-compose build - docker-compose up + sudo docker-compose build + sudo docker-compose up ``` Then open [http://localhost:8000](http://localhost:8000). From 22af0495a2df0e75fb58e248813f648625c35cf2 Mon Sep 17 00:00:00 2001 From: Erik Date: Fri, 2 Apr 2021 11:13:22 +0200 Subject: [PATCH 3/5] Update README.md --- README.md | 82 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 42 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 4e28b7c77..1e9ab074b 100644 --- a/README.md +++ b/README.md @@ -10,46 +10,6 @@ Python bindings for C++ depthai-core library Documentation is available over at [Luxonis DepthAI API](https://docs.luxonis.com/projects/api/en/latest/) -### Building documentation - -- **Using [Docker](https://docs.docker.com/) (with [Docker Compose](https://docs.docker.com/compose/install/))** - - ``` - cd docs - sudo docker-compose build - sudo docker-compose up - ``` - - Then open [http://localhost:8000](http://localhost:8000). - - This docker container will watch changes in the `docs/source` directory and rebuild the docs automatically - -- **Linux** - - First, please install the required [dependencies](#Dependencies) - - Then run the following commands to build the docs website - - ``` - python3 -m pip install -U pip - python3 -m pip install -r docs/requirements.txt - cmake -S . -B build -D DEPTHAI_BUILD_DOCS=ON -D DEPTHAI_PYTHON_BUILD_DOCS=ON - cmake --build build --parallel --target sphinx - python3 -m http.server --bind 0.0.0.0 8000 --directory build/docs/sphinx - ``` - - Then open [http://localhost:8000](http://localhost:8000). - - This will build documentation based on current sources, so if some new changes will be made, run this command - in a new terminal window to update the website source - - ``` - cmake --build build --parallel --target sphinx - ``` - - Then refresh your page - it should load the updated website that was just built - - ## Installation Prebuilt wheels are available in [Luxonis repository](https://artifacts.luxonis.com/artifactory/luxonis-python-snapshot-local/) @@ -101,6 +61,48 @@ ctest - Raspbian 10; - macOS 10.14.6, 10.15.4; + +### Building documentation + +- **Using [Docker](https://docs.docker.com/) (with [Docker Compose](https://docs.docker.com/compose/install/))** + + ``` + cd docs + sudo docker-compose build + sudo docker-compose up + ``` + + You can leave out the `sudo` if you have added your user to the docker group. + + Then open [http://localhost:8000](http://localhost:8000). + + This docker container will watch changes in the `docs/source` directory and rebuild the docs automatically + +- **Linux** + + First, please install the required [dependencies](#Dependencies) + + Then run the following commands to build the docs website + + ``` + python3 -m pip install -U pip + python3 -m pip install -r docs/requirements.txt + cmake -S . -B build -D DEPTHAI_BUILD_DOCS=ON -D DEPTHAI_PYTHON_BUILD_DOCS=ON + cmake --build build --parallel --target sphinx + python3 -m http.server --bind 0.0.0.0 8000 --directory build/docs/sphinx + ``` + + Then open [http://localhost:8000](http://localhost:8000). + + This will build documentation based on current sources, so if some new changes will be made, run this command + in a new terminal window to update the website source + + ``` + cmake --build build --parallel --target sphinx + ``` + + Then refresh your page - it should load the updated website that was just built + ## Troubleshooting ### Relocation link error From f9264c3f4b740cda1cc9655fdd576098c215e437 Mon Sep 17 00:00:00 2001 From: Erik Date: Sat, 3 Apr 2021 09:46:50 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e9ab074b..074299f45 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ ctest sudo docker-compose up ``` - You can leave out the `sudo` if you have added your user to the docker group. + You can leave out the `sudo` if you have added your user to the `docker` group (or are using rootless docker). Then open [http://localhost:8000](http://localhost:8000). From 3a7b748e565267f579e5664423ecbe6bab98ceb7 Mon Sep 17 00:00:00 2001 From: Erik Date: Sat, 3 Apr 2021 11:19:02 +0200 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 074299f45..4a4fcd54a 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ ctest sudo docker-compose up ``` - You can leave out the `sudo` if you have added your user to the `docker` group (or are using rootless docker). + > ℹ️ You can leave out the `sudo` if you have added your user to the `docker` group (or are using rootless docker). Then open [http://localhost:8000](http://localhost:8000).