This is the SMART technical documentation, hosted at http://docs.smartplatforms.org
- See http://smartplatforms.org for high-level project info and news
- Need help? Ask a question at http://groups.google.com/group/smart-app-developers
- Found an error in these docs? Fork them on Github and send us a pull request!
First, you'll need the Jekyll static site generator installed. The full installation instructions are here, but you probaly can just do:
$ gem install jekyll
There are two other libraries to install to generate these documents:
-
redcarpet: our preferred Ruby Markdown processor.$ gem install redcarpet
-
Pygments: the Python-based syntax highligher, this installation instructions for which are at the bottom of the Jekyll page above.
Once the required software is installed, generating the static site (in
the _site directory) is simply running
$ jekyll
on the commandline. In some cases you'll need to do jekyll --no-auto
if Jekyll's file change watching is not working. That command will force
all pages to be regenerated.
Jekyll can serve up the site on http://localhost:4000 by adding
--server to the commands above.
$ jekyll --no-auto --server
will force regeneration of the site (and turn off auto-regeneration) and start the local webserver.
Run the build_docs.py script in the utils directory to re-generate the API
and datamodel documentation from the SMART ontology included via submodule in
the smart_common directory. See the script for configuration details.