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

Changes from 1 commit
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
Prev Previous commit
Next Next commit
update README.md, add building instuctions for docs
  • Loading branch information
@VanDavv
VanDavv committed Mar 17, 2021
commit 4b1275397bc99144d23f75788c115b217cf326c7
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,38 @@ 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
docker-compose build
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)

Comment thread
VanDavv marked this conversation as resolved.
Then run the following commands to build the docs website

```
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
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, these commnads will
have to be run again to build updated website

Comment thread
VanDavv marked this conversation as resolved.

## Installation

Prebuilt wheels are available in [Luxonis repository](https://artifacts.luxonis.com/artifactory/luxonis-python-snapshot-local/)
Expand Down