Metadata-Version: 1.1
Name: sphinxcontrib-vcs
Version: 0.1.0
Summary: Sphinx extension to show commit history in version control system
Home-page: https://github.com/t2y/sphinxcontrib-vcs
Author: Tetsuya Morimoto
Author-email: tetsuya dot morimoto at gmail dot com
License: BSD
Description: sphinxcontrib-vcs
        =================
        
        |Build Status|
        
        *sphinxcontrib-vcs* provides showing commit history in version control
        system.
        
        Setup
        -----
        
        ::
        
            $ pip install sphinxcontrib-vcs
        
        Usage
        -----
        
        Add *'sphinxcontrib.vcs'* as extensions into conf.py.
        
        ::
        
            $ vi conf.py
            extensions = ['sphinxcontrib.vcs']
        
        Then, repository directives are available as follows.
        
        Git
        ~~~
        
        ::
        
            .. git::
                :number_of_revisions: 20
                :with_ref_url:
                :include_diff:
        
        Mercurial
        ~~~~~~~~~
        
        ::
        
            .. mercurial::
                :number_of_revisions: 20
                :with_ref_url:
                :include_diff:
        
        For more information have a look at the documentation.
        
        Note
        ----
        
        `Mercurial <https://www.mercurial-scm.org/>`__ supports Python 2.x only.
        So *sphinxcontrib-vcs* supports the *mercurial* directive on Python 2.7.
        
        Acknowledgments
        ---------------
        
        *sphinxcontrib-vcs* is inspired from the
        `sphinx-git <https://github.com/OddBloke/sphinx-git>`__.
        
        .. |Build Status| image:: https://travis-ci.org/t2y/sphinxcontrib-vcs.svg?branch=master
           :target: https://travis-ci.org/t2y/sphinxcontrib-vcs/
        
        ChangeLog
        ---------
        
        0.1.0 (2016-09-06)
        ~~~~~~~~~~~~~~~~~~
        
        -  first release
        
        
Platform: any
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development :: Libraries
Classifier: Environment :: Console
Classifier: Framework :: Sphinx :: Extension
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Utilities
