-
Notifications
You must be signed in to change notification settings - Fork 204
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.
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
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
0db4009
add docker image
VanDavv bc66d11
change to ubuntu:20.04 base image
VanDavv 903c48f
make docs build work
VanDavv 7c18fed
linting
VanDavv 03fb908
organize the docker files and optimize update script
VanDavv 453a5d9
fix docker build & update
VanDavv 4b12753
update README.md, add building instuctions for docs
VanDavv 0ceff32
remove unneeded flag
VanDavv bb8d8b9
Update documentation and speed up the updates
VanDavv File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -e | ||
|
|
||
| cmake -S . -B build -D DEPTHAI_BUILD_DOCS=ON -D DEPTHAI_PYTHON_BUILD_DOCS=ON | ||
|
|
||
| ./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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -e | ||
|
|
||
| cmake --build build --parallel --target sphinx | ||
|
|
||
| # fix missing index.css file | ||
| cp /app/docs/source/_static/css/* /app/build/docs/sphinx/_static/css |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.