Skip to main content
Help us improve Python packaging – donate today!

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.


Fetch the latest version from Github

git clone git://

and install with:

python install

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

pip install gir2rst


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
    -t TITLE    override the title [available variables: #version (escape with
    -o FILE     write to FILE or stdout if omitted

Release history Release notifications

This version
History Node


History Node


History Node


History Node


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
gir2rst-0.4.tar.gz (17.1 kB) Copy SHA256 hash SHA256 Source None Mar 11, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page