Metadata-Version: 1.1
Name: sphinxcontrib-mockautodoc
Version: 0.0.1dev-20130331
Summary: Sphinx mocking autodoc extension
Home-page: http://bitbucket.org/birkenfeld/sphinx-contrib
Author: Evgeniy Tatarkin
Author-email: tatarkin.evg@gmail.com
License: BSD
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-mockautodoc
Description: mockautodoc
        ===========
        
        Mock imports for build docs without install packages in environment.
        
        This extension add `:mockimport:` and `:mocktype:` for standard automodule
        derictive from autodoc_.
        
        Main goal of extension is to solve task defined on question_.
        
        Install
        -------
        
        ::
        
            pip install sphinxcontrib-mockautodoc
        
        
        Usage
        -----
        
        Add mockautodoc to extensions list::
        
            extenstion = ['sphinxcontrib.mockautodoc', ]
        
        The extension add two options to standard automodule:
        
        - `:mockimport:` list of name spaces to mock separated by ','.
        - `:mocktype:` list of objects which must be mock as type object 
            for right way subclass them in sources, separated by ','.
        
        If you have module for documenting::
            
            from twisted.internet import protocol, defer
            
            @defer.inlineCallbacks
            def my_func():
                """my function"""
                pass
        
            class MyProtocol(protocol.Protocol):
                """my protocol"""
                pass
        
        And twisted_ not installed you can document module like that::
            
            .. automodule:: package
                :mockimport: twisted
                :mocktype: protocol.Protocol
        
        
        Where on `:mockimport:` will be mocked all twisted.* imports
        in automodule building context. And `:mocktype:` means which instances must be 
        object types to successful subclass them without loss target documentation.
        
        
        mockatudoc settings may be defined on conf.py and all automodule directives
        with present `:mockimport:` will be mocked. Where data on mockatodoc settings
        will be summed with `:mockimport:` and `:mocktype:` options::
            
            mockautodoc = {
                'mockimport': ['twisted',],
                'mocktype': ['protocol.Protocol'],
            }
        
        .. _twisted: http://twistedmatrix.com/
        .. _autodoc: http://sphinx-doc.org/ext/autodoc.html
        .. _question: http://stackoverflow.com/questions/15587305/any-ways-build-docs-by-sphinx-with-both-python2-x-and-python3-x-ecosystems
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
