Metadata-Version: 2.1
Name: inkpot
Version: 1.1.0
Summary: a small simple library for generating documentation from docstrings
Home-page: https://github.com/AxelGard/inkpot
Author: Axel Gard
Author-email: axel.gard@tutanota.com
License: MIT
Description: # inkpot
        a small simple library for generating documentation from docstrings
        
        inkpot is available on [pip](https://pypi.org/project/inkpot/). **Please give it a star if you like it!**
        
        <img src="https://cdn.pixabay.com/photo/2014/04/05/12/20/ink-316909_960_720.jpg" alt="drawing" width="300"/>
        
        ![GitHub stars](https://img.shields.io/github/stars/AxelGard/inkpot?style=social)
        ![GitHub forks](https://img.shields.io/github/forks/AxelGard/inkpot?style=social)
        [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/Axel_Gard)
        
        ![GitHub](https://img.shields.io/github/license/AxelGard/inkpot?style=plastic)
        ![PyPI](https://img.shields.io/pypi/v/inkpot)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/inkpot)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/inkpot)
        
        To know more about way I started this project checkout this **[blog post](https://axelgard.github.io/blog/inkpot/2021/07/01/inkpot-init.html)**
        
        ## Installation
        ```bash
        pip install inkpot
        ```
        
        ## Usage
        singel file
        ```bash
        python3 -m inkpot myfile.py
        ```
        or directory
        ```bash
        python3 -m inkpot myproject/
        ```
        output to a file (also works with directories)
        ```bash
        python3 -m inkpot myfile.py > doc.md
        python3 -m inkpot myproject/ > doc.md
        ```
        
        Currently this returns a markdown table.
        More functionality and a better format will be added.
        
        ## Example
        
        Python file `ex/add.py`
        ```python
        def add(a,b):
            """ add to objects """
            return a + b
        
        ```
        ```bash
        python3 -m inkpot ex/add.py
        ```
        returns markdown
        ```
        # ex/add.py
        ## ex/add.py
        | type   | name   | doc-str        |
        |:-------|:-------|:---------------|
        | def    | add    | add to objects |
        | module | add    | None           |
        ```
        
        ## License
        This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
