Metadata-Version: 1.0
Name: sphinxcontrib-smblink
Version: 0.2
Summary: Sphinx Windows Share Links (WSL) role extension
Home-page: https://github.com/goingmywaynet/sphinxcontrib-smblink.git
Author: Joey Chen
Author-email: joey-tech@goingmyway.net
License: BSD
Description: =========================
         sphinxcontrib-smblink
        =========================
        
        This package contains link role for Windows Share Links (WSL)
        Sphinx-based documentation.
        
        
        Installation
        ============
        
        1. download packages from https://github.com/goingmywaynet/sphinxcontrib-smblink.git
        
        2. ``pip install ./sphinxcontrib-smblink``
        
        .. note::
          ``pip install sphinxcontrib-smblink`` <- this is under construction
        
        
        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.
        
        
Keywords: sphinx,sphinxcontrib,smb,windows,link,share
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: Japanese
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
