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.


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

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

gir2rst-0.4.tar.gz (17.1 kB view hashes)

Uploaded Source

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