sphinxcontrib-smblink

Sphinx Windows Share Links (WSL) role extension


Keywords
sphinx, sphinxcontrib, smb, windows, link, share
License
BSD-3-Clause
Install
pip install sphinxcontrib-smblink==0.2

Documentation

=========================
 sphinxcontrib-smblink
=========================

This package contains link role for Windows Share Links (WSL)
Sphinx-based documentation.


Installation
============

::

    pip install sphinxcontrib-smblink


Configuration
=============

1. Add ``'sphinxcontrib.smblink'`` to the ``extensions`` list in ``conf.py``.

  ::

    extensions += [ 'sphinxcontrib.smblink' ]


Usage
=====

To add a link address use something like::

    :smblink:`\\Server\newfolder\to\path`
    :smblink:`folder <\\Server\newfolder\to\path>`

convert to ``file://Server/newfolder/to/path`` style


History
=======

0.1
  Initial Version.

0.2
  PyPI registered