Felipe Monteiro 9d91a072cd docs: Use sphinx-apidoc library for autodoc compatibility

This package is used for generation autodoc documentation
automatically which can be linked to by Deckhand
documentation from other places. This is to make autodoc
generation work in RTD.

More info: https://pypi.org/project/sphinxcontrib-apidoc/

Change-Id: I43aac82728e5935a5a2626f2fd29d7a7188d19f9

2018-10-27 22:52:39 +01:00

1.9 KiB

Raw Permalink Blame History

Welcome to Deckhand's documentation!

Deckhand is a document-based configuration storage service built with auditability and validation in mind. It serves as the back-end storage service for Airship.

Deckhand's primary responsibilities include validating and storing YAML documents that are layered together to produce finalized documents, containing site configuration data, including sensitive data. Secrets can be stored using specialized secret storage management services like Barbican and later substituted into finalized or "rendered" documents.

The service understands a variety of document types, the combination of which describe the manner in which Deckhand renders finalized documents for consumption by other Airship services.

Overview

overview

User's Guide

users/index

Operator's Guide

operators/index

Contrbitutor's Guide

contributor/index

Release Notes

releasenotes/index

Glossary

glossary

1.9 KiB Raw Permalink Blame History