sceptre/docs

Docs

This directory contains the code for Sceptre's docs.

The docs is written using the Jekyll framework.

Ruby

Jekyll depends on Ruby. Documentation on installing Ruby can be found here.

Usage Summary

For more details see make help,

Note: The below assumes you are in the docs directory, if not prefix make commands with docs- e.g make docs-install

Install Jekyll

Jekyll and its dependencies can be installed with:

make install

Build and serve docs locally

The docs can be built with:

make build-latest

To make and serve the docs and watch for changes, run:

make serve-latest

View them at http://localhost:4000/latest/