Skip to content
This repository has been archived by the owner on Mar 13, 2023. It is now read-only.

Commit

Permalink
docs: Depreciation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
LordOfPolls committed Mar 13, 2023
1 parent 3c385df commit 8bd80e1
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 7 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -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. <a>https://github.com/interactions-py/interactions.py</a>
{% endblock %}
4 changes: 3 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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++.

Expand Down
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 ]

Expand Down
5 changes: 5 additions & 0 deletions naff/__init__.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 8bd80e1

Please sign in to comment.