This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Sphinx "mercurial" extension

Project Description

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,

Release History

Release History

This version
History Node

0.2

History Node

0.1dev-20121015

History Node

0.1dev-20121014

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib-mercurial-0.2.tar.gz (4.3 kB) Copy SHA256 Checksum SHA256 Source Oct 27, 2012

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting