Skip to main content

Sphinx "mercurial" extension

Project description


This allows you to include a Mercurial extension of your Sphinx documentation within the documentation.


$ 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']


How to use hg_changelog directive

.. hg_changelog::

where you want the list of commits to appear.

Options of hg_changelog


specify repository root (default: “.”)


set max commits to include (default: 10)


specify which branch to include (default: “default”)


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,


Project details

Download files

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

Source Distribution

sphinxcontrib-mercurial-0.2.tar.gz (4.3 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page