deprecate away!!

please appreciate the depressed cat logo

This is deprecat’s documentation. The primary purpose of this package is to easily deprecate functions, classes or even kwargs in Python and auto-modify sphinx documentation.

Guide

• Installation

• API

• Usage

Authors

• deprecat ( modified from the library deprecated ) is maintained by Meenal Jhajharia

• The original library deprecated is authored by Marcos CARDOSO and Laurent LAPORTE

User’s Guide

• Installation
  • Python Version
  • Stable Release
  • Development Version
• Introduction
  • What’s deprecat anyway?
  • Some background
  • Additional Features
  • Why name it deprecat?
• Usage
  • Deprecated function
  • Deprecated method
  • Deprecated class
  • Sphinx Decorator - Functions
  • Deprecated kwargs
  • Adding Removal Version
  • Live Examples

API Reference

• API

License

• License

Contribute

If you want to contribute, please follow standard OSS practices, clone the repo and make an issue or a PR. Additionally, you can comment on the pages here itself, I’ll make a contributing guide soon.