sphinxcontrib-srclinks

Classifiers

Development Status: 4 - Beta
Environment: Web Environment
Intended Audience: Developers
License: OSI Approved :: BSD License
Operating System: OS Independent
Programming Language: Python
Topic: Documentation; Utilities

sphinxcontrib-srclinks

Sphinxcontrib-srclinks is a Sphinx extension for adding project links to the sidebar.

Usage

Clone the repo and copy srclinks.html into the docs’ _templates/ folder:

git clone https://bitbucket.org/westurner/sphinxcontrib-srclinks

DOCS="path/to/docs"
mkdir -p $DOCS/_templates
cp sphinxcontrib-srclinks/sphinxcontrib/srclinks/_templates/srclinks.html \
    $DOCS/_templates/srclinks.html

Configure the srclink_ settings for the desired repo in conf.py:

# conf.py
srclink_project = 'https://github.com/westurner/sphinxcontrib-srclinks'
srclink_project = 'https://bitbucket.org/westurner/sphinxcontrib-srclinks'
srclink_project = 'hg@bitbucket.org/westurner/sphinxcontrib-srclinks'
srclink_project = 'git@bitbucket.org/westurner/sphinxcontrib-srclinks'
srclink_src_path = 'docs/'
srclink_branch = 'master'

Add srclinks.html to html_sidebars in conf.py:

# Custom sidebar templates, maps document names to template names.
html_sidebars = {
    '**': [
        'localtoc.html',
        'relations.html',
        'searchbox.html',
        'srclinks.html',
        ],
    'index': [
        'globaltoc.html',
        'relations.html',
        'searchbox.html',
        'srclinks.html',
        ],
}