Metadata-Version: 1.1
Name: sphinxcontrib-napoleon
Version: 0.2
Summary: Sphinx "napoleon" extension.
Home-page: https://bitbucket.org/RelentlessIdiot/sphinx-contrib
Author: Rob Ruana
Author-email: rob@relentlessidiot.com
License: BSD
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-napoleon
Description: Napoleon - *Marching toward legible docstrings*
        -----------------------------------------------
        
        Are you tired of writing docstrings that look like this::
        
            :param path: The path of the file to wrap
            :type path: str
            :param field_storage: The :class:`FileStorage` instance to wrap
            :type field_storage: FileStorage
            :param temporary: Whether or not to delete the file when the File
               instance is destructed
            :type temporary: bool
            :returns: A buffered writable file descriptor
            :rtype: BufferedFileStorage
        
        `ReStructuredText`_ is great, but it creates visually dense, hard to read
        `docstrings`_. Compare the jumble above to the same thing rewritten
        according to the `Google Python Style Guide`_::
        
            Args:
                path (str): The path of the file to wrap
                field_storage (FileStorage): The :class:`FileStorage` instance to wrap
                temporary (bool): Whether or not to delete the file when the File
                   instance is destructed
        
            Returns:
                BufferedFileStorage: A buffered writable file descriptor
        
        Much more legible, no?
        
        Napoleon is a `Sphinx extension`_ that allows you to write readable API
        documentation in your source code. Napoleon understands both `NumPy`_ and
        `Google`_ style docstrings - the style recommended by `Khan Academy`_.
        
        .. _ReStructuredText: http://docutils.sourceforge.net/rst.html
        .. _docstrings: http://www.python.org/dev/peps/pep-0287/
        .. _Google Python Style Guide:
           http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
        .. _Sphinx extension: http://sphinx-doc.org/extensions.html
        .. _Google:
           http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments
        .. _NumPy:
           https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
        .. _Khan Academy:
           https://sites.google.com/a/khanacademy.org/forge/for-developers/styleguide/python#TOC-Docstrings
        
        Getting Started
        ---------------
        
        1. After `setting up Sphinx`_ to build your docs, install the
           `sphinxcontrib-napoleon`_ package::
        
               $ pip install sphinxcontrib-napoleon
        
        2. Enable napoleon in the Sphinx `conf.py` file::
        
               # conf.py
        
               # Add autodoc and napoleon to the extensions list
               extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon']
        
        3. Use `sphinx-apidoc` to build your API documentation::
        
               $ sphinx-apidoc -f -o docs/source projectdir
        
        .. _setting up Sphinx: http://sphinx-doc.org/tutorial.html
        .. _sphinxcontrib-napoleon: http://pypi.python.org/pypi/sphinxcontrib-napoleon
        
        Docstrings
        ----------
        
        Napoleon interprets every docstring that `Sphinx autodoc`_ can find, including
        docstrings on: ``modules``, ``classes``, ``attributes``, ``methods``,
        ``functions``, and ``variables``. Inside each docstring, specially formatted
        `Sections`_ are parsed and converted to reStructuredText.
        
        All standard reStructuredText formatting still works as expected.
        
        .. _Sphinx autodoc: http://sphinx-doc.org/ext/autodoc.html
        
        Google vs NumPy
        ---------------
        
        Napoleon supports two styles of docstrings: `Google`_ and `NumPy`_. The main
        difference between the two styles is that Google uses indention to separate
        sections, whereas NumPy uses underlines.
        
        Google style::
        
            def func(arg1, arg2):
                """Summary line.
        
                Extended description of function.
        
                Args:
                    arg1 (int): Description of arg1
                    arg2 (str): Description of arg2
        
                Returns:
                    bool: Description of return value
        
                """
                return True
        
        NumPy style::
        
            def func(arg1, arg2):
                """Summary line.
        
                Extended description of function.
        
                Parameters
                ----------
                arg1 : int
                    Description of arg1
                arg2 : str
                    Description of arg2
        
                Returns
                -------
                bool
                    Description of return value
        
                """
                return True
        
        NumPy style tends to require more vertical space, whereas Google style tends
        to use more horizontal space. Google style tends to be easier to read for
        short and simple docstrings, whereas NumPy style tends be easier to read for
        long and in-depth docstrings.
        
        The `Khan Academy`_ recommends using Google style.
        
        The choice between styles is largely aesthetic, but the two styles should not
        be mixed. Choose one style for your project and be consistent with it.
        
        .. _Sections:
        
        Sections
        --------
        
        All of the following section headers are supported:
        
            * ``Args`` *(alias of Parameters)*
            * ``Arguments`` *(alias of Parameters)*
            * ``Attributes``
            * ``Example``
            * ``Examples``
            * ``Keyword Args`` *(alias of Keyword Arguments)*
            * ``Keyword Arguments``
            * ``Methods``
            * ``Note``
            * ``Notes``
            * ``Other Parameters``
            * ``Parameters``
            * ``Return`` *(alias of Returns)*
            * ``Returns``
            * ``Raises``
            * ``References``
            * ``See Also``
            * ``Warning``
            * ``Warnings`` *(alias of Warning)*
            * ``Warns``
            * ``Yields``
        
        For full documentation see http://sphinxcontrib-napoleon.readthedocs.org
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
