Ian H. Pittwood b22a10ed97 Upgrade Sphinx package
Sphinx 2.1.0 has a bug [0] that causes whitespace to be excluded in
outputted docs. This change updates Sphinx to peg any version >2.1.0.

Safety dependency vulnerability checks now will also cover the doc
requirements.txt.

[0] https://github.com/sphinx-doc/sphinx/issues/6440

Change-Id: Ic4e69862781e35c8597c7eab67a270ba3da26a0d
2019-07-10 12:39:03 -05:00
2019-07-10 12:39:03 -05:00
2018-11-28 02:48:40 -06:00
2019-05-20 08:16:16 -05:00
2018-03-05 07:42:00 -06:00
2018-10-31 15:08:42 -05:00
2019-04-19 19:52:19 +00:00
2019-07-02 12:07:26 +00:00
2018-01-26 15:47:15 -06:00
2019-01-23 09:35:27 +01:00
2019-07-10 12:39:03 -05:00

Pegleg

Docker Repository on Quay Doc Status

Introduction

Pegleg is a document aggregator that provides early linting and validations via Deckhand, a document management micro-service within Airship.

Pegleg supports local and remote Git repositories. Remote repositories can be cloned using a variety of protocols -- HTTP(S) or SSH. Afterward, specific revisions within those repositories can be checked out, their documents aggregated, linted, and passed to the rest of Airship for orchestration, allowing document authors to manage their site definitions using version control.

Find more documentation for Pegleg on Read the Docs.

Core Responsibilities

  • aggregation - Aggregates all documents required for site deployment across multiple Git repositories, each of which can be used to maintain separate document sets in isolation
  • linting - Configurable linting checks documents for common syntactical and semantical mistakes

Getting Started

For more detailed installation and setup information, please refer to the Getting Started guide.

Integration Points

Pegleg has the following integration points:

  • Deckhand which provides document revision management, storage and rendering functionality upon which the rest of the Airship components rely for orchestration of infrastructure provisioning.

Further Reading

Airship.

Description
A configuration organization tool.
Readme 10 MiB
Languages
Python 98.4%
Makefile 0.8%
Shell 0.8%