Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pixeldroid/lsdoc
generate API documentation from doc comments in LoomScript source code
https://github.com/pixeldroid/lsdoc
docs-generator documentation-tool gh-pages jekyll loom loomlib loomscript
Last synced: 1 day ago
JSON representation
generate API documentation from doc comments in LoomScript source code
- Host: GitHub
- URL: https://github.com/pixeldroid/lsdoc
- Owner: pixeldroid
- License: other
- Created: 2016-12-15T03:45:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-04T02:58:44.000Z (about 6 years ago)
- Last Synced: 2024-11-11T04:18:16.864Z (2 months ago)
- Topics: docs-generator, documentation-tool, gh-pages, jekyll, loom, loomlib, loomscript
- Language: LoomScript
- Homepage: https://pixeldroid.com/lsdoc/
- Size: 1.83 MB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lsdoc
an API docs generator for [LoomScript][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](#installation)
- [usage](#usage)
- [building](#building)
- [contributing](#contributing)
## installation
### lsdoc commandline doc generator
> requires [Rake][rake]
Clone this repo.
0. Run `rake cli:install` to:
* build and install the `lsdoc` executable onto the system (`/Users//bin/lsdoc`)
0. 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][loomtasks] (including this one):
$ rake docs
the **lsdoc** loomlib can also be linked into your own Loom project to leverage the [lsdoc API][lsdoc-api] and build your own documentation tool.
## building
first, install [loomtasks][loomtasks] and [bundler][bundler].
then run `bundle install` to retrieve and install the project dependencies on [Jekyll][jekyll] and the [GitHub Pages gem][ghpages-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
### building and serving the docs
$ rake docs
## contributing
Pull requests are welcome!
[bundler]: http://bundler.io "Manage your Ruby application's gem dependencies"
[ghpages]: https://pages.github.com/ "GitHub Pages is a static site hosting service."
[ghpages-gem]: https://github.com/github/pages-gem "A simple Ruby Gem to bootstrap dependencies for setting up and maintaining a local Jekyll environment in sync with GitHub Pages"
[jekyll]: https://jekyllrb.com/ "Jekyll is a blog-aware, static site generator in Ruby"
[loomscript]: https://github.com/LoomSDK/LoomSDK "The Loom SDK, a native mobile app and game framework"
[loomtasks]: https://github.com/pixeldroid/loomtasks "Rake tasks for working with loomlibs"
[lsdoc-api]: https://pixeldroid.github.io/lsdoc/ "API docs for lsdoc"
[lsdoc-releases]: https://github.com/pixeldroid/lsdoc/releases "releases for lsdoc"
[programming-pages]: https://github.com/pixeldroid/programming-pages "a jekyll theme for publishing code documentation to GitHub pages"
[rake]: https://github.com/ruby/rake "A make-like build utility for Ruby"