lsdoc

an API docs generator for LoomScript

see lsdoc api documentation documented by lsdoc here: https://pixeldroid.github.io/lsdoc/

lsdoc provides an API for loading loomlib libraries and extracting type metadata. The distribution provides a command line tool for generating documentation compatible with the programming-pages theme for creating html documentation that is searchable, browsable, cross-linked, and mobile friendly.

• installation
• usage
• building
• contributing

installation

lsdoc commandline doc generator

requires Rake

Clone this repo.

0. Run rake cli:install to:
   • build and install the lsdoc executable onto the system (/Users/<user>/bin/lsdoc)
1. Run rake cli:uninstall to:
   • remove the lsdoc executable from the system

usage

directly from the command line:

$ lsdoc --help

from any Loom project using loomtasks (including this one):

$ rake docs

the lsdoc loomlib can also be linked into your own Loom project to leverage the lsdoc API and build your own documentation tool.

building

first, install loomtasks and bundler.

then run bundle install to retrieve and install the project dependencies on Jekyll and the GitHub Pages gem

compiling from source and installing for use

$ rake cli:install

this will build the lsdoc library, install it in the currently configured sdk, build the command line tool and install it on the path

running tests

$ rake test

this will build the lsdoc library, install it in the currently configured sdk, build the test app, and run the test app.

running the demo

from the project root, before installed on the system

$ export LSDOC=`pwd`
$ export LSDK="$HOME/.loom/sdks/sprint34"
$ rake clean && rake cli['-p ghpages -l $LSDK/libs/LSDoc.loomlib -o $LSDOC/docs']

after tested and installed, invoke in the usual manner:

$ lsdoc <args>

building and serving the docs

$ rake docs

contributing

Pull requests are welcome!