Skip to main content

ReST-based Sphinx documentation from GIR files

Project description

gir2rst provides a package and command-line tool to create Sphinx documentation from GObject-Introspection files.

Installation

Fetch the latest version from Github

git clone git://github.com/matze/gir2rst.git

and install with:

python setup.py install

You can also get the latest release from the Python Package Index

pip install gir2rst

Usage

The command line tool gir2rst will parse the provided .gir files and output the resulting Sphinx documentation on stdout:

usage: gir2rst [-h] [--version] [-t TITLE] [-o FILE] [input [input ...]]

Generate Sphinx documentation from GObject Introspection GIR files.

positional arguments:
  input       .gir input files

  optional arguments:
    -h, --help  show this help message and exit
    --version
    -t TITLE    override the title [available variables: #version (escape with
                '\')]
    -o FILE     write to FILE or stdout if omitted

Project details


Download files

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

Files for gir2rst, version 0.4
Filename, size File type Python version Upload date Hashes
Filename, size gir2rst-0.4.tar.gz (17.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page