Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.18 KB

index.rst

File metadata and controls

39 lines (28 loc) · 1.18 KB

Deconst

Deconstruct your Documentation

Deconst is a continuous delivery pipeline used to assemble documentation from a heterogenous set of source repositories. Individual GitHub repositories containing content in :abbr:`.rst (reStructuredText)` or :abbr:`.md (Markdown)` formats are prepared by being partially rendered to a common JSON format, then mapped to subtrees of the final page by a control repository.

This guide serves two purposes:

  1. It's documentation for deconst itself. If you want to write documentation for a deconst-managed site, or if you want to run a deconst cluster yourself, this will help you get started.
  2. It's also used as a concrete example for deconst's development! We use this to dogfood the deconst contribution and renderer workflow.

Contents:

.. toctree::

   writing-docs/index
   running/index
   developing/index

Indices and tables