Docurium

Docurium generates static HTML from the header files of a C project.

YAML Configuration

docurium:

  • config-file:

    • Path to the Docurium configuration file (api.docurium).
    • If this field is omitted:
      • Docstand automatically searches for api.docurium under your repository and uses it to build documentation.
      • In case when api.docurium has not been found, Docstand generates default api.docurium.
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.5 CPU with 1920 MiB RAM.

Examples

  • With docurium set to default

    docstand:
      docurium: default
    
  • With custom machine:

    docstand:
      docurium:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With config-file option

    docstand:
      docurium:
        config-file: api.docurium
    

    Note : A brief description about api.docurium

    |Options |Description |Default Values |---------------|-----------------------------------------------------------|--------------------- |"name" |required; name of the C project |"{repo-name}" |"github" |required; github path |"{owner-name}/{repo-name}" |"input" |required; path to the header files of the C project |"include" |"prefix" |required; common prefix in C functions |"" |"example" |optional; path to the example directiory |N/A

results matching ""

    No results matching ""