Metadata-Version: 1.1
Name: sphinxcontrib-mercurial
Version: 0.2
Summary: Sphinx "mercurial" extension
Home-page: http://bitbucket.org/cointoss1973/sphinxcontrib-mercurial
Author: Takayuki KONDO
Author-email: tkondou@gmail.com
License: GPLv3
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-mercurial
Description: ==================================
        Mercurial extension for Sphinx
        ==================================
        
        Overview
        ========
        
        This allows you to include a Mercurial extension of your Sphinx documentation
        within the documentation.
        
        Installation
        ============
        
        ::
        
           $ pip install sphinxcontrib-mercurial
        
        
        How to setup
        ============
        
        Once you enable this extension,
        ::
        
            # Add any Sphinx extension module names here, as strings. They can be extensions
            # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
            extensions = ['sphinxcontrib.mercurial']
        
        
        Configulation
        =============
        
        How to use hg_changelog directive
        ---------------------------------
        
        ::
        
          .. hg_changelog::
        
        where you want the list of commits to appear.
        
        Options of hg_changelog
        -----------------------
        
        repo_root_path
          specify repository root (default: ".")
        max_commits
          set max commits to include (default: 10)
        branch
          specify which branch to include (default: "default")
        path
          specify the path to include (default: all)
        
          NOTE: you need to set from repository root.
        
        Example of hg_changelog
        -----------------------
        
        ::
        
          .. hg_changelog::
             :repo_root_path: ../..
             :max_commits: 2
             :path: test/rst
        
        
        How to use hg_version directive
        -------------------------------
        
        ::
        
          .. hg_version::
        
        where you want the version to appear,
        
        
        
        Acknowledgement
        ================
        https://github.com/OddBloke/sphinx-git
        
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
