KiBot Logo

Contents:

  • Introduction
  • Installation
  • Configuration
    • Quick start
    • Section order
    • The header
    • The outputs section
      • Specifying the layers
      • Supported outputs
        • Blender Export
        • BoardView
        • BoM (Bill of Materials)
        • Archiver (files compressor)
        • Files copier
        • Diff
        • Datasheets downloader
        • DXF (Drawing Exchange Format)
        • DXF Schematic Print (Drawing Exchange Format)
        • Excellon drill format
        • GenCAD
        • Gerber drill format
        • Gerber format
        • HPGL (Hewlett & Packard Graphics Language)
        • HPGL Schematic Print (Hewlett & Packard Graphics Language)
        • IBoM (Interactive HTML BoM)
        • Info
        • KiBoM (KiCad Bill of Materials)
        • KiCanvas
        • KiCost (KiCad Cost calculator)
        • KiKit’s Present - Project Presentation
        • KiRi
        • Navigate Results
        • Netlist
        • Panelize
        • PCB2Blender Tools
        • PCB Print
        • PCB with variant generator
        • PcbDraw - Beautiful 2D PCB render
        • PDF (Portable Document Format)
        • PDF PCB Print (Portable Document Format) Deprecated
        • PDF Schematic Print (Portable Document Format)
        • PDF joiner
        • Populate - Assembly instructions builder
        • Pick & place
        • PS (Postscript)
        • PS Schematic Print (Postscript)
        • QR_Lib
        • 3D render of the PCB
        • Design report
        • Schematic with variant generator
        • 3D Printed Stencils
        • Steel Stencils for Alignment Jig
        • STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure)
        • SVG (Scalable Vector Graphics)
        • SVG PCB Print (Scalable Vector Graphics) Deprecated
        • SVG Schematic Print
        • VRML (Virtual Reality Modeling Language)
      • Consolidating BoMs
      • Columns available for the BoM
      • Using other output as base for a new one
      • Grouping outputs
    • The preflight section
    • Default global options
    • Filters and variants
    • Import (include) from other config file
    • Doing YAML substitution or preprocessing
  • Usage
  • Usage for CI/CD

Notes and extra information:

  • Notes about Gerber format
  • Notes about the position file
  • Notes about 3D models
  • Proposed advanced KiCad usage
  • KiPlot YAML
  • Changelog

Final notes:

  • Contributing
  • Credits

Indices and tables:

  • Index
KiBot
  • Configuration
  • The outputs section
  • Navigate Results
  • Navigate_ResultsOptions parameters

Navigate_ResultsOptions parameters

  • link_from_root : [string] (default: '') The name of a file to create at the main output directory linking to the home page.

  • output : [string] (default: '%f-%i%I%v.%x') Filename for the output (%i=html, %x=navigate). Affected by global options.

  • header : [boolean] (default: true) Add a header containing information for the project.

  • logo : [string | boolean] (default: '') PNG file to use as logo, use false to remove. The KiBot logo is used by default.

  • logo_url : [string] (default: 'https://github.com/INTI-CMNB/KiBot/') Target link when clicking the logo.

  • nav_bar : [boolean] (default: true) Add a side navigation bar to quickly access to the outputs.

  • skip_not_run : [boolean] (default: false) Skip outputs with run_by_default: false.

  • title : [string] (default: '') Title for the page, when empty KiBot will try using the schematic or PCB title. If they are empty the name of the project, schematic or PCB file is used. You can use %X values and KiCad variables here.

  • title_url : [string | boolean] (default: '') Target link when clicking the title, use false to remove. KiBot will try with the origin of the current git repo when empty.

Previous Next

© Copyright 2018-2024, Salvador E. Tropea/INTI/John Beard.

Built with Sphinx using a theme provided by Read the Docs.