Mercurial extension for Sphinx
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,
Acknowledgement
1 maintainer
Release files for sphinxcontrib-mercurial 0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxcontrib-mercurial-0.2.tar.gz | 4.3 kB | Details |
Release files / sphinxcontrib-mercurial-0.2.tar.gz
| Download URL | sphinxcontrib-mercurial-0.2.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3f8986814a692b327205570ff69c778ad3c1918b3f2ba6344f41cfc5ce35723d
|
|
BLAKE2b-256 checksum How to use checksums |
883fdccabe4be8c71df0c503c0754c323a81105d35c4ba6625788eb03a2ffc04
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
