1. Forum
  3. Development
  5. Development
  7. Documentation build

Documentation build

More
16 Feb 2017 13:27 #59189 by FDR
Documentation build was created by FDR
How do we build the documentation?
I don't see it in Travis, so I presume it isn't built automatically, but then how can I buil it manually?
Is it included in the docker? I couldn't find it there either...

Please Log in or Create an account to join the conversation.

More
16 Feb 2017 13:58 #59191 by hexfet
Replied by hexfet on topic Documentation build
Yes, I think PB added support in the docker environment. I just run dmake in a clone of deviation-manual. Been so long since setting it up don't remember if I had to install any missing dependencies.

Please Log in or Create an account to join the conversation.

More
16 Feb 2017 15:57 #59197 by FDR
Replied by FDR on topic Documentation build
I don't see dmake in neither the deviation-manual root, nor in the source folder...

Please Log in or Create an account to join the conversation.

More
16 Feb 2017 16:00 #59198 by FDR
Replied by FDR on topic Documentation build
It gives the following error if I call make from the root:
docker@4ba2e219a17d:/git/deviation-manual$ make
Makefile:15: *** The 'virtualenv' command was not found. Make sure you have virt
ualenv installed.  This is typically done via 'sudo pip install -U virtualenv.
Stop.

In the source directory it is even worse, because there is no Makefile:
docker@4ba2e219a17d:/git/deviation-manual/source$ make
make: *** No targets specified and no makefile found.  Stop.

Please Log in or Create an account to join the conversation.

More
16 Feb 2017 16:09 - 16 Feb 2017 16:11 #59199 by hexfet
Replied by hexfet on topic Documentation build
It's in deviation root, one above src. Should be able to use the docker shell too, but need to mount your deviation-manual checkout there.

The documentation Makefile is in deviation-manual, the root directory. The output will be in deviation-manual/build.


~/radiocontrol/deviation/deviation-manual$ dmake
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 13181  100 13181    0     0  90419      0 --:--:-- --:--:-- --:--:-- 90903
Updating build.py
Please use `make <target>' where <target> is one of
  html       to make standalone HTML files
  pdf        to make standalone PDF files via rst2pdf
  epub       to make an epub
  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  latexpdf   to make LaTeX files and run them through pdflatex
  gettext    to make PO message catalogs
  pseudoxml  to make pseudoxml-XML files for display purposes

~/radiocontrol/deviation/deviation-manual$ dmake pdf
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 13181  100 13181    0     0   121k      0 --:--:-- --:--:-- --:--:--  122k
Updating build.py
build/venv/bin/sphinx-build -b pdf -d build/doctrees -t devo8  -E source build/pdf-devo8
Running Sphinx v1.3.1
building [mo]: targets for 0 po files that are out of date
building [pdf]: targets for 14 source files that are out of date
updating environment: 14 added, 0 changed, 0 removed
reading sources... 

<snip>
Last edit: 16 Feb 2017 16:11 by hexfet.

Please Log in or Create an account to join the conversation.

More
16 Feb 2017 16:22 #59200 by FDR
Replied by FDR on topic Documentation build
Something is fishy with my environment, because I only have dmake in the deviation root, not the deviation-manual root.
If I call the deviation's dmake from the deviation-manual directory, I get the same error, which I posted before:
~/git/DeviationTX/deviation-manual (master)
$ ../deviation/dmake pdf
time="2017-02-16T17:18:40+01:00" level=warning msg="Unable to use system certifi
cate pool: crypto/x509: system root pool is not available on Windows"
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 13181  100 13181    0     0   1985      0  0:00:06  0:00:06 --:--:--  3196
Updating build.py
Makefile:15: *** The 'virtualenv' command was not found. Make sure you have virt
ualenv installed.  This is typically done via 'sudo pip install -U virtualenv.
Stop.

I will try it at home again on my home PC...

Please Log in or Create an account to join the conversation.

More
16 Feb 2017 18:20 #59202 by hexfet
Replied by hexfet on topic Documentation build
According to the last section here need to start the shell and run a script to install dependencies.

Please Log in or Create an account to join the conversation.

More
16 Feb 2017 20:45 #59207 by FDR
Replied by FDR on topic Documentation build
I'm ashamed.
I totally forgot that it can be documented in the Wiki... :blush:

It made a bit difficult, that the documentation was wrong because of a Wiki formatting error: the "sudo /root/build.py --manual-prereq" command was written with one hyphen.
However I still can't compile the documentation!
The dmake command always gave an error until I made the above preparation in all of my docker images, since you can't tell, which image will run.
Since that the dmake and the simple make from the shell both give the same errors:
docker@a3c27b85ee58:/git/deviation-manual$ make TARGET=devo10 html pdf
make devbuild
make[1]: Entering directory `/git/deviation-manual'
test -d build/venv || virtualenv build/venv
build/venv/bin/pip install -Ur requirements.txt
make[1]: build/venv/bin/pip: Command not found
make[1]: *** [build/venv/bin/activate] Error 127
make[1]: Leaving directory `/git/deviation-manual'
make: *** [build/venv/bin/sphinx-build] Error 2
FDR@FDR-PC MINGW64 ~/git/DeviationTX/deviation-manual (master)
$ ../deviation/dmake TARGET=devo10 html pdf
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 13181  100 13181    0     0  22435      0 --:--:-- --:--:-- --:--:-- 22416
Updating build.py
make devbuild
make[1]: Entering directory `/git/deviation-manual'
test -d build/venv || virtualenv build/venv
build/venv/bin/pip install -Ur requirements.txt
make[1]: build/venv/bin/pip: Command not found
make[1]: *** [build/venv/bin/activate] Error 127
make[1]: Leaving directory `/git/deviation-manual'
make: *** [build/venv/bin/sphinx-build] Error 2

Please Log in or Create an account to join the conversation.

More
16 Feb 2017 23:43 #59209 by hexfet
Replied by hexfet on topic Documentation build
Do a make clean, then try again. Maybe build/venv directory is remaining from a previous try but doesn't have the correct contents.

Please Log in or Create an account to join the conversation.

  1. Forum
  3. Development
  5. Development
  7. Documentation build
Time to create page: 0.037 seconds
Powered by Kunena Forum
Force desktop display