← Back to team overview

kicad-developers team mailing list archive

Re: Documentation update

 

2015-04-11 9:54 GMT+02:00 Nick Østergaard <oe.nick@xxxxxxxxx>:
> 2015-04-11 1:10 GMT+02:00 Brian Sidebotham <brian.sidebotham@xxxxxxxxx>:
>> On 8 April 2015 at 14:08, Wayne Stambaugh <stambaughw@xxxxxxxxx> wrote:
>>> On 4/8/2015 4:51 AM, Brian Sidebotham wrote:
>>>> On 4 April 2015 at 16:23, Wayne Stambaugh <stambaughw@xxxxxxxxx> wrote:
>>>>> Now that we are in feature freeze, I need an update on where we stand as
>>>>> far as the asciidoc documentation conversion process is concerned.  I
>>>>> did a git pull yesterday and now `make html` fails for a missing po
>>>>> directory.  I have a few questions about the current state of the
>>>>> documentation.
>>>>>
>>>>> 1) Is all of the legacy ODT documentation converted to asciidoc?
>>>>>
>>>>> 2) Does all the English language asciidoc build in both html and
>>>>>    pdf at least on Linux?
>>>>>
>>>>> 3) Do all of the supported translations build?
>>>>>
>>>>> 4) I didn't see any CMake configuration files yet.  Are we making any
>>>>>    progress on that front?
>>>>
>>>> Hi Wayne,
>>>>
>>>> Sorry, I've been really busy doing other stuff, but the CMake stuff is
>>>> underway: https://github.com/BrianSidebotham/kicad-doc
>>>>
>>>> It's still experimental and not fully functional yet, but it can now
>>>> progress better. Nick has fixed the msys2 KiCad-Winbuilder which was
>>>> broken for a while and had me stumped! That project is now close to
>>>> being able to provide decent installers. At the moment it can create
>>>> the installers, but I think there's still some outstanding work to
>>>> make the installers complete.
>>>>
>>>> Hopefully I'll be able to get the CMake stuff up and running pretty
>>>> soon. I'll concentrate on Linux and then make sure things work through
>>>> msys2. PDF generation under msys2 is a pain, but could be possible
>>>> through either asciidoctor-pdf or else a2x and Apache fop.
>>>
>>> What development isn't painful on windows?  Kudos to the msys2 folks for
>>> significantly improving the situation.  It's come a long way from all
>>> the set up work required to get the old msys/mingw32 system to work.
>>> I'll see if I can take a look at your CMake work this weekend.
>>>
>>
>> Hi Wayne,
>>
>> I did a few commits tonight and at least under Linux it'll now build
>> the equivalent of the Makefile stuff for CvPcb and package it up, so
>> that includes all languages in both HTML and PDF.
>
> Hi Brian
>
> I just tried to build the master branch on your fork of the kicad-doc
> repo. I noticed that it does not build pdf for the english version.
> See:
>
> $ ls src/asciidoc/CvPcb/ -gG
> totalt 3112
> drwxr-xr-x 14    320 11 apr 09:45 CMakeFiles
> -rw-r--r--  1   2853 11 apr 09:45 cmake_install.cmake
> -rw-r--r--  1  74799 11 apr 09:45 CvPcb-en.html
> -rw-r--r--  1  31789 11 apr 09:45 CvPcb-fr.adoc
> -rw-r--r--  1  74956 11 apr 09:46 CvPcb-fr.html
> -rw-r--r--  1 867638 11 apr 09:45 CvPcb-fr.pdf
> -rw-r--r--  1  35549 11 apr 09:45 CvPcb-it.adoc
> -rw-r--r--  1  79276 11 apr 09:45 CvPcb-it.html
> -rw-r--r--  1 993656 11 apr 09:46 CvPcb-it.pdf
> -rw-r--r--  1  36179 11 apr 09:45 CvPcb-pl.adoc
> -rw-r--r--  1  80319 11 apr 09:45 CvPcb-pl.html
> -rw-r--r--  1 874894 11 apr 09:45 CvPcb-pl.pdf
> drwxr-xr-x  6    180 11 apr 09:45 images
> -rw-r--r--  1  14120 11 apr 09:45 Makefile
>
> Also using the make target directly does not make it appear together
> with the html.  make cvpcb_pdf_en
>
> But I notice that there is a ../src/asciidoc/CvPcb/CvPcb.pdf.

In case it is not too clear, notice the "..", the path is relative to
a build folder created with mkdir build; cd build; cmake ..; make


Follow ups

References