Socket
Socket
Sign inDemoInstall

sphinxcontrib-mockautodoc

Package Overview
Dependencies
0
Maintainers
1
Alerts
File Explorer

Install Socket

Protect your apps from supply chain attacks

Install

sphinxcontrib-mockautodoc

Sphinx mocking autodoc extension

    0.0.1dev-20130518

Maintainers
1

Readme

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 = ['sphinx.ext.autodoc', '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

FAQs


Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc