Metadata-Version: 2.4
Name: haystack-pydoc-tools
Version: 0.6.4
Summary: Pydoc custom tools for Haystack docs
Project-URL: Documentation, https://github.com/unknown/haystack-pydoc-tools#readme
Project-URL: Issues, https://github.com/unknown/haystack-pydoc-tools/issues
Project-URL: Source, https://github.com/unknown/haystack-pydoc-tools
Author-email: Massimiliano Pippi <mpippi@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: databind<4.5.0
Requires-Dist: pydoc-markdown==4.8.2
Requires-Dist: requests
Requires-Dist: setuptools==81.0.0
Description-Content-Type: text/markdown

# haystack-pydoc-tools

[![PyPI - Version](https://img.shields.io/pypi/v/haystack-pydoc-tools.svg)](https://pypi.org/project/haystack-pydoc-tools)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/haystack-pydoc-tools.svg)](https://pypi.org/project/haystack-pydoc-tools)

-----

**Table of Contents**

- [haystack-pydoc-tools](#haystack-pydoc-tools)
  - [Installation](#installation)
  - [License](#license)

## Installation

```console
pip install haystack-pydoc-tools
```

## License

`haystack-pydoc-tools` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.

## Release process
To release version `x.y.z`:

1. Manually update the version in `src/haystack_pydoc_tools/__about__.py` (via a PR or a direct push to `main`).
2. From the `main` branch, create a tag locally: `git tag vx.y.z`.
3. Push the tag: `git push --tags`.
4. Wait for the CI to release the package on PyPI.
