Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

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,

Project details


Download files

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

Files for sphinxcontrib-mercurial, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-mercurial-0.2.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page