← Back to team overview

kicad-developers team mailing list archive

Re: [PATCH] Docset generation


Hey John,

What exactly does this buy use over the regular doxygen docs?  I'm not
familiar with Zeal.  I don't have the tools installed on my machine to
verify this and I'm not a big fan of using pip on a system that uses a
package manager.  Is doxytag2zealdb packages for any distros?  I would
like a better picture of what this brings to the table and the
availability of any dependencies before I commit it.



On 11/27/2018 12:28 PM, John Beard wrote:
> Hi,
> This is a patch to generate docsets using our existing doxygen set-up.
> Docset documentation makes it very easy to quickly browse the docs
> using Zeal and similar [1], which means you can get IDE integration
> and other nice things.
> The patch adds a "make docset" target. To actually build the docset,
> you will need doxytag2zealdb, a Python program available with pip.
> There is a strange extraneous endif() in the existing version Cmake as
> well, which I
> cannot explain why it currently works at all in its current form!
> The docset can be used to construct a docset feed using the CI
> infrastructure. Basically you need to host the TGZ somewhere and then
> provide an XML which changes the version and the link as needed. Zeal
> then picks up new version availability when checked.
> I have a hastily constructed feed available here [2]. This means you
> can start using a nightly-ish docset today, but updates are not done
> by a CI system. It should be as simple as adding this URL in Zeal [3].
> Cheers,
> John
> [1]: zealdocs.org
> [2]: https://github.com/johnbeard/kicad-docset
> [3]: https://raw.githubusercontent.com/johnbeard/kicad-docset/master/feeds/master/KiCad.xml
> _______________________________________________
> 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