Metadata-Version: 2.1
Name: docfly
Version: 0.0.18
Summary: A utility tool to help you build better sphinx documents.
Home-page: https://github.com/MacHu-GWU/
Author: Sanhe Hu
Author-email: husanhe@me.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@me.com
License: MIT
Download-URL: https://pypi.python.org/pypi/docfly/0.0.18#downloads
Description: .. image:: https://readthedocs.org/projects/docfly/badge/?version=latest
            :target: https://docfly.readthedocs.io/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://travis-ci.org/MacHu-GWU/docfly-project.svg?branch=master
            :target: https://travis-ci.org/MacHu-GWU/docfly-project?branch=master
        
        .. image:: https://codecov.io/gh/MacHu-GWU/docfly-project/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/MacHu-GWU/docfly-project
        
        .. image:: https://img.shields.io/pypi/v/docfly.svg
            :target: https://pypi.python.org/pypi/docfly
        
        .. image:: https://img.shields.io/pypi/l/docfly.svg
            :target: https://pypi.python.org/pypi/docfly
        
        .. image:: https://img.shields.io/pypi/pyversions/docfly.svg
            :target: https://pypi.python.org/pypi/docfly
        
        .. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
            :target: https://github.com/MacHu-GWU/docfly-project
        
        ------
        
        
        .. image:: https://img.shields.io/badge/Link-Document-blue.svg
              :target: https://docfly.readthedocs.io/index.html
        
        .. image:: https://img.shields.io/badge/Link-API-blue.svg
              :target: https://docfly.readthedocs.io/py-modindex.html
        
        .. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg
              :target: https://docfly.readthedocs.io/py-modindex.html
        
        .. image:: https://img.shields.io/badge/Link-Install-blue.svg
              :target: `install`_
        
        .. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
              :target: https://github.com/MacHu-GWU/docfly-project
        
        .. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
              :target: https://github.com/MacHu-GWU/docfly-project/issues
        
        .. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
              :target: https://github.com/MacHu-GWU/docfly-project/issues
        
        .. image:: https://img.shields.io/badge/Link-Download-blue.svg
              :target: https://pypi.org/pypi/docfly#files
        
        
        Welcome to ``docfly`` Documentation
        ==============================================================================
        ``docfly`` is a utility tools to minimize your work using `sphinx-doc <http://www.sphinx-doc.org/en/stable/index.html>`_
        
        **Feature**:
        
        - Automatic API Reference Doc Generation.
        - Easy Table of Content directive Generation (``.. toctree::``).
        
        
        .. _install:
        
        Install
        ------------------------------------------------------------------------------
        
        ``docfly`` is released on PyPI, so all you need is:
        
        .. code-block:: console
        
        	$ pip install docfly
        
        To upgrade to latest version:
        
        .. code-block:: console
        
        	$ pip install --upgrade docfly
Platform: Windows
Platform: MacOS
Platform: Unix
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: docs
Provides-Extra: tests
