Skip to content
This repository was archived by the owner on May 28, 2021. It is now read-only.

Heroku Buildpack for building BOXT API documentation

Notifications You must be signed in to change notification settings

boxt/buildpack-boxt-api-docs-builder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e30c75d · Dec 1, 2020

History

61 Commits
Dec 1, 2020
Nov 10, 2020

Repository files navigation

Boxt API Documentation buildpack

This buildpack should be included as part of Heroku apps that host API documentation.

For more info on how buildpacks work, read the Heroku Buildpacks API: https://devcenter.heroku.com/articles/buildpack-api

Detect

The detect script in ./bin/detect will test for the existence of the boxt_documentation gem on the system. If it's not found, the buildpack will exit, otherwise it will run the script in ./bin/compile.

Compile

The compile script will run the requisite rake tasks on the boxt_documentation gem to build the API documentation.

About

Heroku Buildpack for building BOXT API documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages