Metadata-Version: 1.1
Name: sphinxcontrib-ansibleautodoc
Version: 0.0.4
Summary: autodoc for ansible playbook
Home-page: http://github.com/shirou/sphinxcontrib-ansibleautodoc
Author: WAKAYAMA Shirou
Author-email: shirou.faw@gmail.com
License: BSD
Download-URL: http://pypi.python.org/pypi/sphinxcontrib-ansibleautodoc
Description: sphinxcontrib-ansibleautodoc
        ================================================
        
        `sphinxcontrib-ansibleautodoc` is an sphinx extension which can search task in ansible playbook and generate document.
        
        install
        ----------------
        
        ::
        
          pip install sphinxcontrib-ansibleautodoc
        
        
        and add `'sphinxcontrib.ansibleautodoc'` in extensions in your conf.py.
        
        ::
        
           extensions = [
               'sphinxcontrib.ansibleautodoc',
           ]
        
        
        How to use
        ------------------------
        
        Currently there is one directive called `ansibleautotask`.
        
        ansibleautotask
        ````````````````````````````````````
        
        ::
        
          .. ansibleautotask:: second task
             :playbook: ../ansible/web.yml
        
        The contents of this directive is an ansible task name. If task does not have a name, directive can not find.
        
        `playbook` option is for specify initial ansible playbook. ansibleautodoc scan the playbook and read include and roles as followes. So you need only one playbook file.
        
        
        Output Example
        --------------------
        
        .. image:: images/screenshot-1.png
           :scale: 50 %
        
        Related
        ----------
        
        Ansible
          https://ansible.com
        
        License
        -------------
        
        2-clause BSD License
        
        
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: Topic :: Documentation
Classifier: Topic :: Utilities
