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 alonside 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.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14036b583c999090fb9832d6f3b7ee9bfc1d3abf8ef2309c3946666bbbaef241 |
|
MD5 | 1d922d8f26752f75ec408a79de609a2c |
|
BLAKE2b-256 | fa11c765c4fef394bf9aa40a87bc56d4b1f88d205d3fea8763df4fb6ced1fe44 |