Skip to content

Add docker image that allows to run docs in development mode #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VanDavv merged 9 commits into from
Mar 17, 2021
Merged

Add docker image that allows to run docs in development mode #157

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0db4009
add docker image
VanDavv Mar 4, 2021
bc66d11
change to ubuntu:20.04 base image
VanDavv Mar 5, 2021
903c48f
make docs build work
VanDavv Mar 5, 2021
7c18fed
linting
VanDavv Mar 14, 2021
03fb908
organize the docker files and optimize update script
VanDavv Mar 16, 2021
453a5d9
fix docker build & update
VanDavv Mar 16, 2021
4b12753
update README.md, add building instuctions for docs
VanDavv Mar 17, 2021
0ceff32
remove unneeded flag
VanDavv Mar 17, 2021
bb8d8b9
Update documentation and speed up the updates
VanDavv Mar 17, 2021
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
9 changes: 9 additions & 0 deletions docs/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
services:
docs:
build:
dockerfile: docs/docker/dev.dockerfile
context: ..
volumes:
- ./:/app/docs
ports:
- 8000:8000
13 changes: 13 additions & 0 deletions docs/docker/dev.dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM ubuntu:20.04

ARG DEBIAN_FRONTEND=noninteractive
RUN apt-get update && apt-get install -y libusb-1.0-0-dev clang python3-opencv python3-pip clang-11 doxygen cmake git
RUN python3 -m pip install -U pip numpy when-changed

ENV CC clang-10
ENV CXX clang++-10
WORKDIR /app
ADD docs/requirements.txt docs/requirements.txt
RUN python3 -m pip install -r docs/requirements.txt
ADD . .
CMD docs/docker/docker_run.sh
9 changes: 9 additions & 0 deletions docs/docker/docker_run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/bash

set -e

./docs/docker/update_docs.sh

when-changed -r docs/source -c "bash /app/docs/docker/update_docs.sh" &

python3 -m http.server --bind 0.0.0.0 8000 --directory build/docs/sphinx
10 changes: 10 additions & 0 deletions docs/docker/update_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/bin/bash

set -e

rm -rf build/docs/sphinx
cmake -S . -B build -D DEPTHAI_BUILD_DOCS=ON -D DEPTHAI_PYTHON_BUILD_DOCS=ON -D ENABLE_PRECOMPILED_HEADERS=OFF
cmake --build build --parallel --target sphinx

# fix missing index.css file
cp /app/docs/source/_static/css/* /app/build/docs/sphinx/_static/css
4 changes: 2 additions & 2 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Sphinx==3.4.3
sphinx-tabs==1.3.0
sphinx-rtd-theme==0.5.0
git+git://github.com/VanDavv/rtd-redirects.git@3e7333898acad533b37c9de426f1f2ef258d756b
git+https://github.com/VanDavv/rtd-redirects.git@3e7333898acad533b37c9de426f1f2ef258d756b
breathe==4.26.0
git+git://github.com/luxonis/pybind11_mkdoc.git@master
git+https://github.com/luxonis/pybind11_mkdoc.git@master
Sphinx-Substitution-Extensions==2020.9.30.0
sphinx-autopackagesummary==1.3
autodocsumm==0.2.2