shipyard/docs/source/sampleconf.rst
Felipe Monteiro 467358dcc2 Shipyard documentation via build_sphinx
This PS adds tooling and automation to automatically generate
Shipyard's documentation into feature-rich HTML pages that can
be hosted.

To run the documentation job, simply execute:

    tox -e docs

Shipyard's .md documentation will have to be changed to .rst
in a future PS for sphinx to be able to render them into HTML.

Change-Id: Iba8cfd68e4905d49cd5a1dfd39d556044efdabbd
2017-10-06 15:51:35 -04:00

1.1 KiB

Sample Configuration File

The following is a sample Shipyard configuration for adaptation and use. It is auto-generated from Shipyard when this documentation is built, so if you are having issues with an option, please compare your version of Patrole with the version of this documentation.

The sample configuration can also be viewed in file form.

_static/shipyard.conf.sample