Metadata-Version: 1.1
Name: dycco
Version: 1.0.1
Summary: Literate-programming-style documentation generator.
Home-page: https://github.com/mccutchen/dycco
Author: Will McCutchen
Author-email: will@mccutch.org
License: MIT
Description: =====
        Dycco
        =====
        
        Dycco is a(nother) Python port of `Docco`_, the original quick-and-dirty,
        hundred-line-long, literate-programming-style documentation generator. For an
        example and more information, see `its self-generated docs`_.
        
        This port of Docco has fewer features than the pimary Python port, `Pycco`_.
        For instance, Dycco can generate documentation for Python files and nothing
        else. It was written mostly as a reason to play with Python's AST.
        
        You should probably use `Pycco`_ instead.
        
        
        Installation
        ============
        
        Use `pip`_ to install::
        
            pip install dycco
        
        
        Usage
        =====
        
        Command Line Usage
        ------------------
        
        Just pass ``dycco`` a list of files and it will generate documentation for each
        of them. By default, the generated documentation is put in a ``docs/``
        subdirectory::
        
            $ dycco my_python_file.py
        
        Dycco can generate docs for multiple files at once::
        
            $ dycco my_package/*.py
        
        And you can control the output location::
        
            $ dycco --output-dir=/path/to/docs my_package/*.py
        
        All command line options are given below::
        
            $ dycco --help
        
        Outputs::
        
            usage: dycco [-h] [-o OUTPUT_DIR] source_file [source_file ...]
        
            Literate-style documentation generator.
        
            positional arguments:
              source_file           Source files to document
        
            optional arguments:
              -h, --help            show this help message and exit
              -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                                    Output directory (will be created if necessary)
        
        Library Usage
        -------------
        
        Dycco can also be used as a plain old Python library::
        
            >>> import dycco
            >>> dycco.document('my_python_file.py', 'my_output_dir')
        
        
        Credits
        =======
        
        Dycco is just a simple re-implementation of `Docco`_, with some inspiration and
        template code from its primary Python port `Pycco`_.
        
        .. _Docco: http://jashkenas.github.com/docco/
        .. _Pycco: http://fitzgen.github.com/pycco/
        .. _pip: http://www.pip-installer.org/
        .. _its self-generated docs: https://mccutchen.github.io/dycco/
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT 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 :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
