Metadata-Version: 2.1
Name: apibook
Version: 0.1.1
Summary: API documentation generator for MdBook
Keywords: mdbook apidoc documentation markdown
Author-Email: Tom Solberg <me@sbg.dev>
License: MIT License
        
        Copyright (c) 2022 Tom Solberg
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: Markdown
Project-URL: Repository, https://github.com/tgolsson/python-apibook
Project-URL: Changelog, https://github.com/tgolsson/python-apibook/tree/main/CHANGELOG.md
Requires-Python: >=3.9
Requires-Dist: docstring_parser
Requires-Dist: rich
Description-Content-Type: text/markdown

# `python-apibook`

[![GitHub deployments](https://img.shields.io/github/deployments/tgolsson/python-apibook/github-pages?style=flat&logo=markdown&label=Documentation&link=)](https://tgolsson.github.io/python-apibook/)[![PyPI - Version](https://img.shields.io/pypi/v/apibook?logo=pypi&label=Latest%20version)](https://pypi.org/project/python-apibook)

Are you tired of fighting Sphinx to get it to do what you want? Do you want to write your documentation in Markdown? Do you want to easily combine prose with API docs? Then this is the tool for you!

`python-apibook` uses the AST module to parse your code and generate API documentation in Markdown format, and can easily be merged into your existing `mdbook` `SUMMARY.md` file.

## Installation

```bash
pip install git+https://github.com/tgolsson/python-apibook.git
```

## Usage

To see the available options, run:
```bash
python -m apibook.cli --help
```

To generate API documentation for a package, run:
```bash
python-apibook my_package doc/src --summary-template-file doc/SUMMARY.tmpl
```

This will generate all markdown sources and a `SUMMARY.md` file in the `doc/src` directory, which you can include in your `mdbook` project. _Hint_: Combine this with `mdbook serve doc` to see the results in real-time.
