Metadata-Version: 2.1
Name: sphinxcontrib-gitinclude
Version: 0.0.1
Summary: Sphinx extension to include code from git repository
Home-page: https://sphinxcontrib-gitinclude.readthedocs.org/
Author: Oz Tiram
Author-email: oz.tiram@gmail.com
License: BSD
Keywords: sphinx git documentation
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Requires-Python: >=3.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*, !=3.5.*, !=3.6.*
License-File: LICENSE

=========================
 sphinxcontrib-gitinclude
=========================

.. image:: https://readthedocs.org/projects/sphinxcontrib-gitinclude/badge/?version=latest
   :target: https://readthedocs.org/projects/sphinxcontrib-gitinclude/?badge=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.

.. _Sphinx: http://www.sphinx-doc.org/en/stable/
.. _PyPI: http://pypi.python.org/pypi/sphinxcontrib-gitinclude
.. _documentation: http://sphinxcontrib-gitinclude.readthedocs.org


