Skip to content
/ zig_doc Public

Documentation transform which parses zig files and converts to ex_doc docs

License

Notifications You must be signed in to change notification settings

E-xyza/zig_doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ZigDoc

Parses Zig files and transforms them into ExDoc documentation.

Note: ZigDoc is pinned to versions of ExDoc as it uses private features in ExDoc.

Usage

You'll want to alias the mix docs task to ZigDoc. In your mix.exs file:

def project do
  [
    ...
    aliases: [docs: "zig_doc", ...]
  ]
end

Configuration

Installation

The package can be installed by adding zig_doc to your list of dependencies in mix.exs:

def deps do
  [
    {:zig_doc, "== 0.1.0"}
  ]
end

Documentation can be found at https://hexdocs.pm/zig_doc.

About

Documentation transform which parses zig files and converts to ex_doc docs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published