.. Automatically generated by KiBot, please don't edit this file

.. index::
   pair: Navigate Results; navigate_results

Navigate Results
~~~~~~~~~~~~~~~~

Generates a web page to navigate the generated outputs


Type: ``navigate_results``


Parameters:

-  **comment** :index:`: <pair: output - navigate_results; comment>` [string=''] A comment for documentation purposes. It helps to identify the output.
-  **dir** :index:`: <pair: output - navigate_results; dir>` [string='./'] Output directory for the generated files.
   If it starts with `+` the rest is concatenated to the default dir.
-  **name** :index:`: <pair: output - navigate_results; name>` [string=''] Used to identify this particular output definition.
   Avoid using `_` as first character. These names are reserved for KiBot.
-  **options** :index:`: <pair: output - navigate_results; options>` [dict] Options for the `navigate_results` output.

   -  Valid keys:

      -  **link_from_root** :index:`: <pair: output - navigate_results - options; link_from_root>` [string=''] The name of a file to create at the main output directory linking to the home page.
      -  **output** :index:`: <pair: output - navigate_results - options; output>` [string='%f-%i%I%v.%x'] Filename for the output (%i=html, %x=navigate). Affected by global options.
      -  ``skip_not_run`` :index:`: <pair: output - navigate_results - options; skip_not_run>` [boolean=false] Skip outputs with `run_by_default: false`.

-  **type** :index:`: <pair: output - navigate_results; type>` [string=''] Type of output.
-  ``category`` :index:`: <pair: output - navigate_results; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
   Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
   The categories are currently used for `navigate_results`.

-  ``disable_run_by_default`` :index:`: <pair: output - navigate_results; disable_run_by_default>` [string|boolean] Use it to disable the `run_by_default` status of other output.
   Useful when this output extends another and you don't want to generate the original.
   Use the boolean true value to disable the output you are extending.
-  ``extends`` :index:`: <pair: output - navigate_results; extends>` [string=''] Copy the `options` section from the indicated output.
   Used to inherit options from another output of the same type.
-  ``groups`` :index:`: <pair: output - navigate_results; groups>` [string|list(string)=''] One or more groups to add this output. In order to catch typos
   we recommend to add outputs only to existing groups. You can create an empty group if
   needed.

-  ``output_id`` :index:`: <pair: output - navigate_results; output_id>` [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
-  ``priority`` :index:`: <pair: output - navigate_results; priority>` [number=10] [0,100] Priority for this output. High priority outputs are created first.
   Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
-  ``run_by_default`` :index:`: <pair: output - navigate_results; run_by_default>` [boolean=true] When enabled this output will be created when no specific outputs are requested.