← Back to team overview

kicad-developers team mailing list archive

Re: documentation format

 

On 2/5/2015 5:03 AM, Fat-Zer wrote:
> 2015-02-04 19:52 GMT+03:00 Wayne Stambaugh <stambaughw@xxxxxxxxx>:
>>
>> CMake should be used as the build configuration tool which is used to
>> verify all of the required tools are installed on the system and
>> automatically generate the appropriate Makefiles. CMake files would go
>> in the kicad-doc repo and replace the current Makefiles.
>>
>> It would be nice if everything was in one place. That may be a goal for
>> the distant future. For now, we have more important issues to worry about.
>>
> Hi, I've done some cmake macro scripting for building asciidoc based
> on Marco's repository some time ago:
> https://github.com/Fat-Zer/kicad-doc
> It's ready to use for generate output in several formats like docbook,
> pdf, html and other.
> But, by the word, it doesn't check some special additional
> dependencies for specific formats... may be I'll add a test if
> specified format may be build in future...

This is important.  The build configuration should always test for
dependencies and fail during the configuration rather than fail during
the build for missing dependencies.  Brian has graciously offered to
help with the CMake stuff.  He has a lot of experience in this area.
Brian, would you please take a look at the CMake stuff and see what
needs to be done to get this production ready?  Once it's cleaned up, it
should be merged into Marco's branch so that the documentation and the
build configuration is in the same place.

Marco, you may want to enlist some help.  Once all of the documentation
and build configuration is ready to go, I expect that there will be a
lot of pull requests to get the documentation ready for the stable release.

I haven't had time to look but is there any documentation on how to
contribute and create translations using the CMake configuration?  It
might be a good idea to provide this for new contributors.  I'm guessing
not all of our documentation folks are familiar with using cmake, git,
and github.  We want to make sure that it is as easy as possible for
folks to contribute documentation.

Thanks,

Wayne

> 
> I've gonna to report it after I'll add some macro to update the *.po
> files but have not finished it yet...
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
> 



Follow ups

References