This repo has been archived and is no longer maintained.

cirrus-docs

cirrus-docs is a plugin for the cirrus-geo processing pipeline framework to add documentation commands to the cirrus cli. The plugin allows a cirrus project instance to develop and build documentation, pulling in the docs for cirrus-geo, cirrus-lib, all of the available components, and any installed plugins.

Quickstart

cirrus-docs in pip-installable:

pip install cirrus-docs

When installed alongside cirrus-geo, it will add a docs subcommand to the cirrus cli, which can be used within a Cirrus project to initialize, stage, and build the project documentation:

~ ❯ cd project-dir
~/project-dir ❯ cirrus docs init
~/project-dir ❯ cirrus docs stage
`/project-dir ❯ cirrus docs build

cirrus-docs is built on top of sphinx. See the full plugin documentation for more information about how to use it.