Metadata-Version: 2.1
Name: pydoc_quarto
Version: 0.0.11
Summary: Generate minimal reference API docs from a python library in the form of markdown files that can be rendered in Quarto.
Home-page: https://github.com/hamelsmu/pydoc_quarto
Author: hamelsmu
Author-email: hamel.husain@gmail.com
License: Apache Software License 2.0
Keywords: quarto python
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

pydoc-quarto
================

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Install

``` sh
pip install pydoc_quarto
```

## Usage

``` python
!pydoc_quarto -h
```

    usage: pydoc_quarto [-h] lib dest_dir

    Generate Quarto Markdown API docs

    positional arguments:
      lib         the name of the python library
      dest_dir    the destination directory the markdown files will be rendered into

    options:
      -h, --help  show this help message and exit

## Example

This will generate markdown files for the `requests` library:

``` python
!pydoc_quarto requests _test_dir/
!ls _test_dir/
```

    adapters.qmd     compat.qmd       hooks.qmd        status_codes.qmd
    api.qmd          cookies.qmd      models.qmd       structures.qmd
    auth.qmd         exceptions.qmd   packages.qmd     utils.qmd
    certs.qmd        help.qmd         sessions.qmd


