Skip to content

smarkets/smk_api_docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Generates documentation for the Smarkets API

To generate a copy of the docs in build/ type:

    make

To generate a copy of the docs with the version set to a specific version edit rebar.conf to grab the correct version'd dependancies and type:

    make VSN=0.1.2       # 0.1.2 being the git tag for the specific API revision

To generate smk_api_docs-VSN.tar.gz edit rebar.conf to grab the correct version'd dependancies and type:

    make dist VSN=0.1.2

When building distributed documentation the rebar dependency entries for smk_api_common and eto_common need be {tag,"VSN"} where VSN is a semantic versioned tag the docs should be made built for. These version numbers will be rendered next to the "seto" and "eto" links in the menu on the left.

About

Smarkets API documentation generator

Resources

License

Stars

Watchers

Forks

Packages

No packages published