Skip to content

Commit

Permalink
Merge pull request #627 from opendatacube/cli_tool_doc
Browse files Browse the repository at this point in the history
Autodocument CLI tools from man pages.
  • Loading branch information
SpacemanPaul authored Jun 11, 2021
2 parents 700516b + 35f3301 commit 1ef981e
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx_click']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
25 changes: 25 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,38 @@
Usage
=====

.. contents:: Table of Contents

As a Python Module
------------------

To use datacube-ows in a project::

import datacube_ows

To use the `stand-alone styling API <https://datacube-ows.readthedocs.io/en/latest/cfg_style_api.html>`_::

from datacube_ows.styles.api import *


OWS Command Line Tools
----------------------------

Datacube-OWS provides two command line tools:

* ``datacube-ows-update`` that for creating and maintaining OWS's
`database tables and views <https://datacube-ows.readthedocs.io/en/latest/database.html>`_.
* ``datacube-ows-cfg`` which is used for managing
`OWS configuration files <https://datacube-ows.readthedocs.io/en/latest/configuration.html>`_.

.. click:: datacube_ows.update_ranges:main
:prog: datacube-ows-update
:nested: full

.. click:: datacube_ows.cfg_parser:main
:prog: datacube-ows-update
:nested: full

As a Web-Service in Docker with Layers deployed
-----------------------------------------------

Expand Down

0 comments on commit 1ef981e

Please sign in to comment.