Skip to content
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

Jump to bottom

Add support for building documentation via docker #151

Merged
merged 3 commits into from
Mar 4, 2020
Merged

Add support for building documentation via docker #151

merged 3 commits into from
Mar 4, 2020

Conversation

tavip
Copy link
Member

@tavip tavip commented Mar 2, 2020

No description provided.

@tavip tavip force-pushed the lkt-docker-docs branch from a4a66c6 to 59a5c6c Compare March 2, 2020 14:59
tavip pushed a commit to linux-kernel-labs/linux-kernel-labs.github.io that referenced this pull request Mar 2, 2020
Publish lkt-docker-docs (built from linux-kernel-labs/linux#151)
5062a63
@tavip tavip force-pushed the lkt-docker-docs branch from 59a5c6c to 60a2292 Compare March 2, 2020 16:31
tavip pushed a commit to linux-kernel-labs/linux-kernel-labs.github.io that referenced this pull request Mar 2, 2020
Publish lkt-docker-docs (built from linux-kernel-labs/linux#151)
1ff0c6f
@tavip tavip force-pushed the lkt-docker-docs branch from 60a2292 to 9206e4a Compare March 2, 2020 16:38
@tavip tavip force-pushed the lkt-docker-docs branch from 9206e4a to 384eb7c Compare March 2, 2020 16:47
@Sergiu121
Copy link

Doesn't compile for me:

cd docs && docker-compose build
Building docs-build
Step 1/17 : FROM ubuntu:18.04
---> 72300a873c2c
Step 2/17 : RUN apt-get update
---> Using cache
---> ea83be63980f
Step 3/17 : RUN apt-get install -y software-properties-common
---> Using cache
---> f43fa14e7bf1
Step 4/17 : RUN apt-get install -y sudo
---> Using cache
---> 672ada898ae3
Step 5/17 : RUN apt-get install -y make
---> Using cache
---> e2ffc91057d5
Step 6/17 : RUN apt-get install -y git
---> Using cache
---> 2ecd8b630cd2
Step 7/17 : RUN apt-get install -y python
---> Using cache
---> b9343843b0d4
Step 8/17 : RUN apt-get install -y python-pip
---> Using cache
---> bd2a24c3fb61
Step 9/17 : RUN apt-get install -y ditaa
---> Using cache
---> 391b4124affb
Step 10/17 : RUN apt-get install -y graphviz
---> Using cache
---> 047c39ca29a8
Step 11/17 : RUN pip install Sphinx==1.6.7 sphinx_rtd_theme hieroglyph==1.0
---> Using cache
---> 42f9ea8bfb2c
Step 12/17 : RUN rm -rf /var/lib/apt/lists/*
---> Using cache
---> f2ba04c4a1c3
Step 13/17 : RUN useradd -ms /bin/bash ubuntu && adduser ubuntu sudo && echo -n 'ubuntu:ubuntu' | chpasswd
---> Using cache
---> 78677c425729
Step 14/17 : RUN sed -i.bkp -e 's/%sudo\s+ALL=(ALL(:ALL)?)\s+ALL/%sudo ALL=NOPASSWD:ALL/g' /etc/sudoers
---> Using cache
---> a79563ba5504
Step 15/17 : USER ubuntu
---> Using cache
---> dfd2c5390d71
Step 16/17 : WORKDIR /home/ubuntu/
---> Using cache
---> c7c803687af4
Step 17/17 : ENV PATH ${PATH}:/home/ubuntu/.local
---> Using cache
---> ddf71af7c299
Successfully built ddf71af7c299
Successfully tagged docs_docs-build:latest
cd docs && docker-compose run docs-build bash -c "cd /linux/tools/labs && make docs"
make -C /linux DOCBOOKS= SPHINXDIRS="teaching" htmldocs
make[1]: Entering directory '/linux'
HOSTCC scripts/basic/fixdep
scripts/basic/fixdep.c:402:1: fatal error: opening dependency file scripts/basic/.fixdep.d: Permission denied
}
^
compilation terminated.
scripts/Makefile.host:90: recipe for target 'scripts/basic/fixdep' failed
make[2]: *** [scripts/basic/fixdep] Error 1
Makefile:466: recipe for target 'scripts_basic' failed
make[1]: *** [scripts_basic] Error 2
make[1]: Leaving directory '/linux'
Makefile:39: recipe for target 'docs' failed
make: *** [docs] Error 2
make: *** [Makefile:36: docker-docs] Error 2

@tavip tavip force-pushed the lkt-docker-docs branch from 384eb7c to 02a2b70 Compare March 3, 2020 06:19
@tavip tavip force-pushed the lkt-docker-docs branch from 02a2b70 to 7c61c42 Compare March 3, 2020 06:36
@tavip tavip force-pushed the lkt-docker-docs branch 2 times, most recently from 27a95c8 to 9a8bab0 Compare March 3, 2020 07:38
@tavip
Copy link
Member Author

tavip commented Mar 3, 2020

@Sergiu121 can you please check with the latest commits?

@Sergiu121
Copy link

@tavip works fine now.

@tavip tavip requested review from dbaluta, Sergiu121 and valighita March 3, 2020 13:14
tavip added 3 commits March 3, 2020 15:17
@tavip
Documentation: ditaa: pick command invocation from env vars
c5c5420 
Currently the ditaa command is invoked directly and assumes that
binfmt_misc support is enabled on the host to execute ditaa via jexec
or jarwrapper. However that is not true in all cases (e.g. docker
guests does not yet properly support binfmt_misc).

This commit adds support for command invocation customization with two
environment variables: SPHINX_DITAA_CMD to specify the executable and
SPHINX_DITAA_ARG to specify a list of parameters.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
@tavip
tools: labs: remove pip install from docs make target
08336cb 
pip depedencies belong to the host setup environment. We will provide
a Dockerfile to deal with host dependencies.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
@tavip
tools: labs: add docker-docs target that builds documentation with do…
f9efbb3 
…cker

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
@tavip tavip force-pushed the lkt-docker-docs branch from e5c318a to f9efbb3 Compare March 3, 2020 13:24
@tavip tavip merged commit 5231d1b into linux-kernel-labs:master Mar 4, 2020
@tavip tavip deleted the lkt-docker-docs branch March 4, 2020 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@valighita valighita valighita approved these changes

@dbaluta dbaluta Awaiting requested review from dbaluta

@Sergiu121 Sergiu121 Awaiting requested review from Sergiu121

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tavip @Sergiu121 @valighita