SlothCreator: Building Documentation with Gungnir in Odin

Build Gungnir documentation for an Odin project that contains a DocG Catalog.

Overview

This sample code project was based on Apple’s Sloth Creator (MIT).

Note

The original SlothCreator sample code project is associated with the WWDC21 sessions:

• 10166: Meet DocC documentation in Xcode.
• 10167: Elevate your DocC documentation in Xcode.
• 10236: Host and automate your DocC Documentation.
• 10235: Build interactive tutorials in DocC.

Is recommended to check them to learn more about Swift’s DocC, main inspiration for Gungnir.

Configure the Sample Code Project

To build documentation for this package, use Gungnir, go to the project root (where project.odin file is located) and execute the following command:

$ gungnir .