runestone help

[bnmnetp]

@RunestoneInteractive/contributors :

I came up with the following on a bike ride this morning and it turned out to be really easy to add.

A new sub-command for runestone called runestone help - it uses the docstrings of the directives to provide a really quick help for each directive. The docstrings should be really up to date, and will be easy to maintain as they are right in the source.

/V/T/s/R/R/r/activecode (rs-help)> runestone help
Available Commands:
build  [--all]      * build the current project
deploy               * deploy the current proejct using rsync
serve [--port]   * start a simple webserver for the current project
help list             * list all runestone directives
or type help <directive> for doc on a runestone directive

bmiller@zebra /V/T/s/R/R/r/activecode (rs-help)> runestone help list
Runestone Directives List
   activecode
   blank
   clickablearea
   codelens
   datafile
   disqus
   dragndrop
   fillintheblank
   mchoice
   parsonsprob
   poll
   qnum
   reveal
   shortanswer
   tab
   tabbed
   timed
   usageassignment
   video
   vimeo
   youtube
 bmiller@zebra /V/T/s/R/R/r/activecode (rs-help)> runestone help mchoice

.. mchoice:: uniqueid
   :multiple_answers: boolean  [optional]
   :random: boolean [optional]
   :answer_a: possible answer  -- what follows _ is label
   :answer_b: possible answer
   ...
   :answer_e: possible answer
   :correct: letter of correct answer or list of correct answer letters (in case of multiple answers)
   :feedback_a: displayed if a is picked
   :feedback_b: displayed if b is picked
   :feedback_c: displayed if c is picked
   :feedback_d: displayed if d is picked
   :feedback_e: displayed if e is picked

   Question text   ...

I could easily imagine using this with my favorite editor as an addition to rst mode where I could type mchoice and get a template for a multiple choice question.

[presnick]

Nice!