Skip to main content

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

Metadata

Release files for gir2rst 0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gir2rst 0.4
File Size Uploaded
gir2rst-0.4.tar.gz 17.1 kB Details

Release files / gir2rst-0.4.tar.gz

Download URL gir2rst-0.4.tar.gz
Size 17.1 kB
Tags Source
SHA-256 checksum
How to use checksums
24119c787e72733aedf0d02c33702ecfc2b1a997ab97e9175e72aca885592cdc
BLAKE2b-256 checksum
How to use checksums
7193d6697ec293c4438851e47385a3ddd0200a10264668c3d56661834e88cbb4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.4 This release

1 release file

0.3

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page