Utilities to manage cirrus project documentation.
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cirrus_docs-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40f8083c674c1cf1a57f6e66646d90d638673d42d50a498eb0fff07a6cf52572 |
|
MD5 | 95559d8229c376c3e7a0a9a15cee146f |
|
BLAKE2b-256 | c67d764945465aa2fba0611bf7d3a133a9d2e3478cec99ec863c29b17c7231ad |