Uploaded image for project: 'Titanium SDK/CLI'
  1. Titanium SDK/CLI
  2. TIMOB-10688

CLI: Expose Docgen.py and YAML as Alternative to Markdown in Modules

    Details

      Description

      New Feature

      Expose docgen.py / YAML so that our modules' documentation can be rewritten. The docgen.py looks hard coded for use with the core Titanium Mobile, and it isn't packaged up with the SDK.

      Example Usage

      Take a look at the attached Barcode.yml. If this were included in a module's "documentation" folder, build.py on iOS or ant on Android should generate an index.html etc in the distribution folder.

      I'm guessing we'll need platform specific tickets for this... let me know.

      • validate.py should be able to be run against module docs that have references to Titanium.* Currently, the module docs need to be copied to the apidoc folder in titanium_mobile so that it can validate without throwing errors that Titanium.* could not be found. I believe if validate.py could accept multiple -d directories it would fix this.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                jalter Jon Alter
                Reporter:
                dtoth Dawson Toth
              • Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Backbone Issue Sync

                  • Backbone Issue Sync is enabled for your project, but we do not have any synchronization info for this issue.

                    Git Integration