Sphinx extension to include code from git repository
Project description
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sphinxcontrib-gitinclude-0.0.1.tar.gz.
File metadata
- Download URL: sphinxcontrib-gitinclude-0.0.1.tar.gz
- Upload date:
- Size: 14.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f7b9159ce730d8843960fb053ffe2555e13bca410a8e5a428e5f935cdf0b930 |
|
| MD5 | 0d39bd0768bb078d3ec17ec9ebfab13c |
|
| BLAKE2b-256 | f94c14d4fcb83af013df4b14429b229bf51cbaeb2ffca0b5a55fae8e6f524724 |
