Sphinx "mercurial" extension
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']
where you want the list of commits to appear.
- 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.
.. hg_changelog:: :repo_root_path: ../.. :max_commits: 2 :path: test/rst