467358dcc2
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
27 lines
1.1 KiB
ReStructuredText
27 lines
1.1 KiB
ReStructuredText
..
|
|
Copyright 2017 AT&T Intellectual Property. All other rights reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
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>`_.
|
|
|
|
.. literalinclude:: _static/shipyard.conf.sample
|