Source

sphinx-hg /

Filename Size Date modified Message
sphinxcontrib
22 B
34.3 KB
876 B

Mercurial extension for Sphinx

Overview

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

How to use

To use it, add 'sphinx_hg' to 'extensions' in your Sphinx conf.py, and add:

where you want the list of commits to appear.

Options

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

.. hg_changelog::
   :repo_root_path: ../..
   :max_commits: 2
   :path: test/rst