Skip to content

Instantly share code, notes, and snippets.

@johnbeard

johnbeard/docset.md

Last active October 17, 2018 16:41
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save johnbeard/931bfe1468ff2447fe17291dc5a9b11e to your computer and use it in GitHub Desktop.
Save johnbeard/931bfe1468ff2447fe17291dc5a9b11e to your computer and use it in GitHub Desktop.
Download ZIP
KiCad docset
Raw
docset.md

Some notes, as this needs a bit of thought before it can be added to anything.

  • Modify the Doxyfile
GENERATE_DOCSET = YES
DOCSET_FEEDNAME = "KiCad PCB EDA Suite"
DOCSET_BUNDLE_ID = org.kicad-pcb.kicad
DISABLE_INDEX = YES
GENERATE_TREEVIEW = NO
SEARCHENGINE = NO
GENERATE_TAGFILE = kicad.tag
  • Make the docs: cd build; make doxygen-docs
  • Go to the generated docs: cd ../Documentation/doxygen/html
  • Run the doxygen-made makefile there make. This fails due to lack of docsetutils. That's OK.
  • Run doxytag2zealdb:
doxytag2zealdb --tag ~/src/kicad/kicad.tag \
--db ~/src/kicad/Documentation/doxygen/html/org.kicad-pcb.kicad.docset/Contents/Resources/docSet.dsidx \
--include-parent-scopes --include-function-signatures
  • Copy the icon from the website:
wget http://kicad-pcb.org/favicon-16x16.png -O org.kicad-pcb.kicad.docset/icon.png

  • Update the Info.plist file: change DocSetPlatformFamily to kicad (from doxygen). This provides the search prefix in Zeal.

  • You can copy this or symlink it to your Zeal docset directory:

cp -r org.kicad-pcb.kicad.docset ~/.local/share/Zeal/Zeal/docsets/
  • Optional: Archive the docset:
tar -cvzf org.kicad-pcb.kicad.tgz org.kicad-pcb.kicad.docset
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment