Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 1.42 KB

configuration_file-format.md

File metadata and controls

75 lines (47 loc) · 1.42 KB

Configuration file

The behaviour of gdnative-doc can be configured via a toml configuration file.

The current options are:

  • url_overrides

    Here you can specify a list of items for which the linking url should be overriden.

    Example

    # link `bool` to the latest documentation instead of stable.
    url_overrides = { bool = "https://docs.godotengine.org/en/latest/classes/class_bool.html" }
  • rename_classes

    Here you can a list of structures that will be renamed.

    This is useful because GDNative allows defining a script_class_name in the .gdns file.

    Example

    // in lib.rs
    
    #[derive(NativeClass)]
    #[inherit(Reference)]
    /// My Rust interface
    pub struct RustStructure {}
    rename_classes = { RustStructure = "GodotClass" }
  • markdown_options

    List of optional markdown options.

  • Valid options

    • FOOTNOTES
    • SMART_PUNCTUATION
    • STRIKETHROUGH
    • TABLES
    • TASKLISTS

    Default

    No option enabled.

    Example

    markdown_options = ["STRIKETHROUGH", "TABLES", "TASKLISTS"]
  • opening_comment

    Boolean that control whether or not to include a comment in the generated files.

    The comment includes information such that the file was automatically generated, the name of the source file it originated from...

    Default

    true

    Example

    opening_comment = false