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
35 lines
1.0 KiB
ReStructuredText
35 lines
1.0 KiB
ReStructuredText
..
|
|
Copyright 2017 AT&T Intellectual Property.
|
|
All 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.
|
|
|
|
====================================
|
|
Welcome to Shipyard's documentation!
|
|
====================================
|
|
|
|
Shipyard is a directed acyclic graph controller for Kubernetes and OpenStack
|
|
control plane life-cycle management.
|
|
|
|
User's Guide
|
|
============
|
|
|
|
Shipyard Configuration Guide
|
|
----------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
sampleconf
|
|
policy-enforcement
|