GitHub - NSUSpray/LiveAPI_MakeDoc: This script generates Live API documentation in XML format, based on realtime inspection of the Live module.

This repository has been archived by the owner on Feb 1, 2022. It is now read-only.

NSUSpray / LiveAPI_MakeDoc Public archive

Notifications You must be signed in to change notification settings
Fork 6
Star 13

This script generates Live API documentation in XML format, based on realtime inspection of the Live module.

remotescripts.blogspot.com/p/support-files.html

13 stars 6 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
_Sample_Output		_Sample_Output
_Support		_Support
LiveAPI_MakeDoc.py		LiveAPI_MakeDoc.py
ReadMe.txt		ReadMe.txt
__init__.py		__init__.py

Repository files navigation

http://remotescripts.blogspot.com

----------------------
API_MakeDoc revision 0
----------------------

This set of Python scripts will generate Live API documentation in XML format, based on realtime inspection of the Live module. Compatible with Live 8.1 & higher, on PC or mac. 

To run, first drop the API_LiveDoc folder into Ableton's MIDI Remote Scripts directory:

MAC OS X -> /Applications/Live 8.x OS X/Live.app/Contents/App-Resources/MIDI Remote Scripts/
PC -> C:\Program Files\Ableton\Live 8.x\Resources\MIDI Remote Scripts\ 

Next, select "API_MakeDoc" from the MIDI Preferences dialog, then reset immediately to "None" (there is no need to close the dialog first). Two files will be written to the userhome directory: Live.xml and Live.css (sample output is included in the _Sample_Output directory). To locate the userhome directory:

MAC OS X -> click the Home icon in the Finder toolbar
PC -> C:\Documents and Settings\username\

Open Live.xml in a web browser to view the API documentation.

----------------
Revision History
----------------

2011-03-20 
* Initial API_MakeDoc release

Visit http://remotescripts.blogspot.com for the latest updates and more information


----------
DISCLAIMER
----------

THESE FILES ARE PROVIDED AS-IS, WITHOUT ANY WARRANTY, EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO FITNESS FOR ANY PARTICULAR PURPOSE.