diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 3602b76d..86a52c24 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -2,22 +2,22 @@ kibot: version: 1 preflight: - # [boolean=false] Zones are filled before doing any operation involving PCB layers + # [boolean=false] Zones are filled before doing any operation involving PCB layers. check_zone_fills: true - # [list(dict)] A list of entries to filter out ERC/DRC messages + # [list(dict)] A list of entries to filter out ERC/DRC messages. filters: - filter: 'Filter description' error: '10' regex: 'Regular expression to match' - # [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing + # [boolean=false] Option for `run_drc`. Ignores the unconnected nets. Useful if you didn't finish the routing. ignore_unconnected: false - # [boolean=false] Runs the DRC (Distance Rules Check). To ensure we have a valid PCB + # [boolean=false] Runs the DRC (Distance Rules Check). To ensure we have a valid PCB. run_drc: true - # [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct + # [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct. run_erc: true # [boolean=false] Update the XML version of the BoM (Bill of Materials). - To ensure our generated BoM is up to date. - Note that this isn't needed when using the internal BoM generator (`bom`) + # To ensure our generated BoM is up to date. + # Note that this isn't needed when using the internal BoM generator (`bom`). update_xml: true outputs: diff --git a/kibot/config_reader.py b/kibot/config_reader.py index 15914e6f..c7ef2011 100644 --- a/kibot/config_reader.py +++ b/kibot/config_reader.py @@ -391,7 +391,9 @@ def create_example(pcb_file, out_dir, copy_options, copy_expand): pres = BasePreFlight.get_registered() for n, o in OrderedDict(sorted(pres.items())).items(): if o.__doc__: - f.write(' #'+o.__doc__.rstrip()+'\n') + lines = trim(o.__doc__.rstrip()+'.') + for ln in lines: + f.write(' # '+ln.rstrip()+'\n') f.write(' {}: {}\n'.format(n, o.get_example())) # Outputs outs = RegOutput.get_registered()