Source

sphinxcontrib-mercurial /

Filename Size Date modified Message
doc
sphinxcontrib
47 B
34.3 KB
49 B
876 B
81 B
1.1 KB
329 B
==================================
Mercurial extension for Sphinx
==================================

Overview
========

This allows you to include a Mercurial extension 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:

.. 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
================
https://github.com/OddBloke/sphinx-git

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.