Code Monkey home page Code Monkey logo

sphinx-click's Introduction

sphinx-click

CI Status

Documentation Status

sphinx-click is a Sphinx plugin that allows you to automatically extract documentation from a click-based application and include it in your docs.

Installation

Install the plugin using `pip`:

$ pip install sphinx-click

Alternatively, install from source by cloning this repo then running `setup.py`:

$ python setup.py install

Usage

Important

To document a click-based application, both the application itself and any additional dependencies required by that application must be installed.

Enable the plugin in your Sphinx conf.py file:

extensions = ['sphinx_click.ext']

Once enabled, you can now use the plugin wherever necessary in the documentation.

.. click:: module:parser
   :prog: hello-world
   :show-nested:

Detailed information on the various options available is provided in the documentation.

sphinx-click's People

Contributors

stephenfin avatar awegnergithub avatar jirikuncar avatar muggenhor avatar adamtheturtle avatar ahmed-masud avatar readmodifywrite avatar albireox avatar hroncok avatar omercnet avatar knownnexus avatar williamjamir avatar frostming avatar jtrakk avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.