Skip to main content

Sphinx directive for invoke

Project description

https://travis-ci.org/nokia/sphinx-invoke.svg?branch=master

Documentation

Documentation for sphinx-invoke can be found from Read The Docs.

Sphinx directive for invoke tasks

The package sphinx-invoke contains the Sphinx directive which produces the usage and help for the invoke task.

For example:

.. invoke::
     :module: module.path.to.tasks
     :prog: programname

Essentially produces sections for each task with the content:

programname -h taskname

Installation

The package can be installed with pip:

# pip install sphinx-invoke

Development practices

The development and the testing follows the Common Robot Libraries development practices defined in crl-devutils.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-invoke-0.2.1.tar.gz (16.2 kB view details)

Uploaded Source

File details

Details for the file sphinx-invoke-0.2.1.tar.gz.

File metadata

  • Download URL: sphinx-invoke-0.2.1.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.15

File hashes

Hashes for sphinx-invoke-0.2.1.tar.gz
Algorithm Hash digest
SHA256 c485a849ae3a13398614d3943ce7494e7fd66f89eb96915b00ee25f0afd57942
MD5 248d12c1de89e74403c7c8327ed52726
BLAKE2b-256 3cf68000dc54d1ad2e9284686c195c661f5fcd14c70618ac557f125ac77940c2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page