Module f.docs

Part of fixture

fixture documentation utilities
Function get_object_from_path Undocumented
Function include_docstring include reStructuredText from a docstring. use the directive like:
Function api_only only include a block of rst if generating API documentation.
Function shell insert a shell command's raw output in a pre block, like::
def get_object_from_path(rawpath):
Undocumented
def include_docstring(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine):

include reStructuredText from a docstring. use the directive like:

.. include_docstring:: path.to.module
.. include_docstring:: path.to.module:SomeClass
.. include_docstring:: path.to.module:SomeClass.method
def api_only(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine):
only include a block of rst if generating API documentation.
def shell(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine):

insert a shell command's raw output in a pre block, like:

| .. shell:: mycmd --arg 1
API Documentation for fixture, generated by pydoctor.