Metadata-Version: 2.1
Name: mkdocs-yaarg-plugin
Version: 0.0.1a5
Summary: Yet Another API Reference Generator plugin for MKDocs.
Home-page: https://github.com/g6123/mkdocs-yaarg-plugin
Author: g6123
Author-email: gg6123@naver.com
License: MIT
Description: # mkdocs-yaarg-plugin
        
        **Y**et **A**nother **A**PI **R**eference **G**enerator plugin for [MKDocs](https://www.mkdocs.org/).
        
        ## Installation
        
        Install package from PyPI,
        
        ```
        pip install mkdocs-yaarg-plugin
        ```
        
        then add it to `mkdocs.yml`:
        
        ```yaml
        plugins:
          - yaarg
        ```
        
        ## Usage
        
        ```markdown
        # API Reference
        
        ::: some/filepath/to/module.py
        ```
        
        See [documentation](https://g6123.github.io/mkdocs-yaarg-plugin/) for other options and details.
        
        ## Why
        
        As a Python docstring documentation generator:
        
        - Fast & static
        
        `yaarg`'s default Python generator does not depend on any runtime data.
        Executing Python code to build a documentation is simply unnecessary, slow and potentially dangerous.
        
        As a general API reference generator:
        
        - Language agnostic
        - Unopinionated on how markdown output should look like
        
        So that one can easily exploit exisiting documentation tooling in their eco-system.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
