diff --git a/README.md b/README.md index 89edd3230..ddd712860 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ [![Discord](https://img.shields.io/discord/870046872864165888?color=%235865F2&label=Server&logo=discord&logoColor=%235865F2)](https://discord.gg/hpfNhH8BsY) [![Documentation Status](https://readthedocs.org/projects/naff-docs/badge/?version=latest)](https://naff-docs.readthedocs.io/en/latest/?version=latest) +# Depreciation Notice +Please note the naff package is now deprecated. Please migrate to interactions.py, where future development will continue. https://github.com/interactions-py/interactions.py +Interactions.py V5 is a combined release between interactions.py and naff. Migration is easy, and should only take an hour at most. + # What is this? This is `NAFF`, a python API wrapper for Discord. NAFF is intended to be fast, easy to use, and easily modified to suit your needs. diff --git a/docs/overrides/main.html b/docs/overrides/main.html index db97176ba..d51d086ee 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -1,5 +1,5 @@ {% extends "base.html" %} {% block announce %} - These docs are not completed. Please do not panic if something is missing or inaccurate -{% endblock %} + Please note the naff package is now deprecated. Please migrate to interactions.py. https://github.com/interactions-py/interactions.py +{% endblock %} \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index f0b0c5eda..5807bb783 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -5,7 +5,9 @@ hide: - feedback --- !!! danger "Remember" - These docs are not completed. Please do not panic if something is missing or inaccurate. + Please note the naff package is now deprecated. Please migrate to [interactions.py](https://github.com/interactions-py/interactions.py), where future development will continue. + Interactions.py V5 is a combined release between interactions.py and naff. Migration is easy, and should only take an hour at most. + We hope this documentation is helpful for you, but don't just ++ctrl+c++ and ++ctrl+v++. diff --git a/mkdocs.yml b/mkdocs.yml index cac5698bb..a804bf2f7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,7 @@ site_url: https://naff.info/ theme: name: material favicon: images/favicon.png - # custom_dir: docs/overrides + custom_dir: docs/overrides features: - header.autohide - navigation.instant @@ -124,9 +124,9 @@ plugins: - minify: minify_html: true # keep these at the bottom of the plugins list - - privacy: - externals: bundle - enabled: !ENV [ DEPLOY, False ] +# - privacy: +# externals: bundle +# enabled: !ENV [ DEPLOY, False ] - offline: enabled: !ENV [ DEPLOY, False ] diff --git a/naff/__init__.py b/naff/__init__.py index eaf255420..6c35001d5 100644 --- a/naff/__init__.py +++ b/naff/__init__.py @@ -1,9 +1,14 @@ +from warnings import warn + from .client import * from .client.const import * from .models import * from .api import * from . import ext + +warn("The naff package is deprecated and will be removed in a future version. Please migrate to interactions.py where future development will be taking place. https://github.com/interactions-py/interactions.py", DeprecationWarning, stacklevel=2) + ######################################################################################################################## # Credits # LordOfPolls -- Lead Contributor