Sphinx "mercurial" extension
Project description
Overview
This allows you to include a Mercurial extension of your Sphinx documentation within the documentation.
How to use
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.hg_changelog']
and add
.. hg_changelog::
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
Acknowledgement
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for sphinxcontrib-mercurial-0.1dev-20121015.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5567f4eb9031378289ad536b9a2711677960d11c71a0a43252a8218eda154d80 |
|
MD5 | f66039d840a25f71cfd2fcc561899a0c |
|
BLAKE2b-256 | f9e075e1e4d5be9327be2b94362485892543c48df62205df6bed919309a584f0 |