Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add API doc generation #12

Merged
merged 12 commits into from
Sep 4, 2018
Merged

Add API doc generation #12

merged 12 commits into from
Sep 4, 2018

Commits on Aug 21, 2018

  1. Add step to clone Interbit repo for source comment parsing.

    @btlewan
    btlewan committed Aug 21, 2018
    Configuration menu
    Copy the full SHA
    280be06 View commit details
    Browse the repository at this point in the history

  2. Remove the _interbit folder from the rendered HTML.

    @btlewan
    btlewan committed Aug 21, 2018
    Configuration menu
    Copy the full SHA
    4a2e5f0 View commit details
    Browse the repository at this point in the history

  3. Merge branch 'master' into ewan/add-api-parsing

    @btlewan
    btlewan committed Aug 21, 2018
    Configuration menu
    Copy the full SHA
    164e2b5 View commit details
    Browse the repository at this point in the history

Commits on Aug 24, 2018

  1. Merge branch 'master' into ewan/add-api-parsing

    @btlewan
    btlewan committed Aug 24, 2018
    Configuration menu
    Copy the full SHA
    5c40927 View commit details
    Browse the repository at this point in the history

Commits on Aug 27, 2018

  1. Add processing to auto-generate API markup via jsdoc: 

    * Add a jsdoc configuration file.
* Runs jsdoc on specific packages, capturing API details from source
  comments.
* Converts the JSON from jsdoc into Asciidoc markup.
* Adds reference documentation that includes the generated Asciidoc
  markup.
* Adds NPM commands to package.json that allow the spell and includes CI
  checks to be executed explicitly.
* make.sh now uses console colors to delineate processing stages.
    @btlewan
    btlewan committed Aug 27, 2018
    Configuration menu
    Copy the full SHA
    93b9af9 View commit details
    Browse the repository at this point in the history

  2. Add missing jsdoc dependency.

    @btlewan
    btlewan committed Aug 27, 2018
    Configuration menu
    Copy the full SHA
    febf6b1 View commit details
    Browse the repository at this point in the history

Commits on Aug 30, 2018

  1. Update reference/interbit topics to adopt new API styling, and include 

    the remainder of the generated function API details.
    @btlewan
    btlewan committed Aug 30, 2018
    Configuration menu
    Copy the full SHA
    44f4f1f View commit details
    Browse the repository at this point in the history

  2. Update SUMMARY.md, as the config selectors and manifest selectors 

    topics have been separated into individual, function-specific topics.
    @btlewan
    btlewan committed Aug 30, 2018
    Configuration menu
    Copy the full SHA
    bf82a5b View commit details
    Browse the repository at this point in the history

  3. Show which package is having its source comments processed.

    @btlewan
    btlewan committed Aug 30, 2018
    Configuration menu
    Copy the full SHA
    2ae2e0f View commit details
    Browse the repository at this point in the history

  4. Move the post-build cleanup steps into a separate script, so that they 

    can be called independently.
    @btlewan
    btlewan committed Aug 30, 2018
    Configuration menu
    Copy the full SHA
    de930cc View commit details
    Browse the repository at this point in the history

Commits on Aug 31, 2018

  1. Fix rendering of reference links.

    @btlewan
    btlewan committed Aug 31, 2018
    Configuration menu
    Copy the full SHA
    66639d6 View commit details
    Browse the repository at this point in the history

Commits on Sep 4, 2018

  1. Address feedback.

    @btlewan
    btlewan committed Sep 4, 2018
    Configuration menu
    Copy the full SHA
    2b2acca View commit details
    Browse the repository at this point in the history