KiCad_SiteOptions parameters

  • base_url : [string] (default: '') Base URL for the generated site. I.e. https://USER.github.io/PROJECT/ Without the version part.

  • title : [string] (default: '') Title for the site, leave empty to use the one from hugo.yaml. %X and KiCad variables are expanded.

  • assembly_models : [KiCad_SiteAssembly parameters] [dict | list(dict)] (default: []) 3D assembly models.

  • bom : [string] (default: '') Name of the BoM output to use as embedded HTML. Use None to skip.

  • dest_subdir : [string] (default: 'static') Subdirectory where the files will be copied inside the destination dir.

  • diffs : [KiCad_SiteDiff parameters] [dict | list(dict)] (default: []) Diff resources, usually one for the PCB and another for the schematic.

  • downloads : [KiCad_SiteDownload parameters] [dict | list(dict)] (default: []) Downloadable resources for releases, not for latest.

  • force_copy : [boolean] (default: false) By default we skip the copy to the destination dir if the file is already there and newer. Enabling this option we always do the copy.

  • ibom : [string] (default: '') Name of the iBoM output. Use None to skip.

  • kiri : [string] (default: '') Name of the KiRi output to use as embedded HTML. Use None to skip.

  • pcb_first : [boolean] (default: false) List the PCB first, KiCanvas will show the PCB by default, instead of the schematic.

  • renders : [string | list(string)] (default: '') Name of one or more outputs providing images for the PCB.

  • version : [string] (default: 'auto') Version for the generated site. auto tries to figure out it. Currently it just uses the GITHUB_REF environment variable to detect a tag, otherwise it just assumes this is latest.

Used dicts