Skip to main content

Sphinx extension to include code from git repository

Project description

https://readthedocs.org/projects/sphinxcontrib-gitinclude/badge/?version=latest

A Sphinx extension to insert code snippets from a git repository, helping you to keep a repository of versions working code examples.

Installation

Install this extension from PyPI:

pip install sphinxcontrib-gitinclude

The extension requires Sphinx 3.7.0 or later and Python 3.7 or later.

Usage

Just add this extension to extensions:

extensions = ['sphinxcontrib.gitinclude']

Now you can use a new directive gitinclude to insert code from a git repository.

For more information on how to use this project see the example directory with a project that uses this directive.

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

sphinxcontrib-gitinclude-0.0.1.tar.gz (14.0 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