Add docker image that allows to run docs in development mode#157
Merged
Conversation
themarpe
requested changes
Mar 15, 2021
Collaborator
There was a problem hiding this comment.
2 questions. Should we move the files to eg docker directory (just so to not run on development machine, as the scripts are not intended to? (Or we tweak them a tad more to be used locally as well, while still moving docker only things to separate directory.
Second, in update_docs.sh the rm -rf build is expensive to perform. I advise to rather just clean out sphinx build directory: build/docs/sphinx (and maybe doxygen build/depthai-core/docs/xml)
(Also, I think this PR should target develop, discussing locally about documentation branches)
themarpe
requested changes
Mar 17, 2021
Collaborator
themarpe
left a comment
There was a problem hiding this comment.
Add documentation to README.md covering both:
- Building documentation without docker
- Using the created docker
Contributor
Author
|
@themarpe added the info to README.md |
themarpe
requested changes
Mar 17, 2021
themarpe
approved these changes
Mar 17, 2021
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I'm using Arch-based distro, and with the new build system in place, I cannot build the docs as stated, because I don't have anything under
/usr/lib/llvm-*- which is accessed bypybind11_mkdocwhile searching forlib/libclang.so.1.This PR introduces Docker image, that allows to run the container that will build the docs whenever they are changed and host it, allowing to access the locally-built documentation