diff --git a/.gitignore b/.gitignore index 0aa45d9..24a63dc 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ .idea/ dist/ -docs/_build +tests/ +docs/_build/ diff --git a/docs/conf.py b/docs/conf.py index 6703413..9a6277d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,12 +27,12 @@ author: str = "Axel#3456" copyright: str = "2022 Axelancerr" -with open(os.path.abspath(os.path.join(os.path.dirname(__file__), '../slate/__init__.py'))) as file: +with open(os.path.abspath(os.path.join(os.path.dirname(__file__), "../slate/__init__.py"))) as file: if not (match := re.search(r"^__version__: [^=]* = \"([^\"]*)\"", file.read(), re.MULTILINE)): raise RuntimeError - _VERSION: str = match.group(1) + _VERSION: str = match[1] version: str = _VERSION release: str = _VERSION diff --git a/docs/images/slate.jpg b/docs/images/slate.jpg deleted file mode 100644 index b23d947..0000000 Binary files a/docs/images/slate.jpg and /dev/null differ diff --git a/docs/index.rst b/docs/index.rst index c9a1bd6..d47a98e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,34 +2,17 @@ Welcome to slate ================ - -.. image:: /images/slate.jpg - -slate is a :resource:`lavalink ` and :resource:`obsidian ` -python wrapper for use with :resource:`discord.py's ` command extension. +slate is a discord.py compatible wrapper for lavalink-like applications. Installation ------------ -From PyPI - From GitHub: -.. tab:: Linux - - .. code:: bash - - git clone https://github.com/Axelware/slate - cd aiolastfm - python3 -m pip install . - -.. tab:: Windows - - .. code:: bash - - git clone https://github.com/Axelware/slate - cd aiolastfm - py -3 -m pip install . +.. code:: bash + git clone https://github.com/Axelware/slate + cd slate + python3.10 -m pip install . Contents -------- diff --git a/docs/pages/api.rst b/docs/pages/api.rst index ef49e99..3c26c8f 100644 --- a/docs/pages/api.rst +++ b/docs/pages/api.rst @@ -4,45 +4,29 @@ API Reference ============= placeholder text -Clients -------- -placeholder text - Pool ^^^^ -.. autoclass:: Pool +.. autoclass:: slate.Pool :members: Node ^^^^ -.. autoclass:: Node +.. autoclass:: slate.Node :members: - Player ^^^^^^ -.. autoclass:: Player +.. autoclass:: slate.Player :members: - Queue ^^^^^ -.. autoclass:: Queue - :members: - - -Utils ----------- -placeholder text - -.. automodule:: slate.utils +.. autoclass:: slate.Queue :members: Exceptions ---------- -placeholder text - .. automodule:: slate.exceptions :members: diff --git a/pyproject.toml b/pyproject.toml index f1a8e79..f30314e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,3 +1,8 @@ +[build-system] +requires = ["poetry_core>=1.0.0"] +build-backend = "poetry.core.masonry.api" + + [tool.poetry] name = "slate" version = "0.2.2" @@ -8,9 +13,7 @@ readme = "README.md" homepage = "https://github.com/Axelware/slate" repository = "https://github.com/Axelware/slate" documentation = "https://slate-py.readthedocs.io/en/latest/" -keywords = [ - "obsidian", "lavalink", "api", "wrapper", "async" -] +keywords = ["obsidian", "lavalink", "api", "wrapper", "async"] classifiers = [ "Framework :: AsyncIO", "Topic :: Software Development", @@ -30,7 +33,7 @@ packages = [ { include = "slate/py.typed" }, ] include = [ - "LICENSE", + "LICENSE" ] @@ -43,18 +46,26 @@ sphinxcontrib-trio = { version = "*", optional = true } sphinx-copybutton = { version = "*", optional = true } sphinx-inline-tabs = { version = "*", optional = true } furo = { version = "*", optional = true } -sphinx-autobuild = { version = "*", optional = true } [tool.poetry.dev-dependencies] -isort = "*" -"discord.py" = { git = "https://github.com/Rapptz/discord.py" } +isort = "*" +typing_extensions = "*" +"discord.py" = { git = "https://github.com/Rapptz/discord.py" } [tool.poetry.extras] -dev = ["discord.py"] -docs = ["discord.py", "sphinx", "sphinxcontrib-trio", "sphinx-copybutton", "sphinx-inline-tabs", "furo"] -docs-dev = ["discord.py", "sphinx", "sphinxcontrib-trio", "sphinx-copybutton", "sphinx-inline-tabs", "furo", "sphinx-autobuild"] +dev = [ + "discord.py" +] +docs = [ + "discord.py", + "sphinx", + "sphinxcontrib-trio", + "sphinx-copybutton", + "sphinx-inline-tabs", + "furo" +] [tool.poetry.urls] @@ -78,14 +89,12 @@ import_heading_firstparty = "Local" import_heading_localfolder = "Local" -[build-system] -requires = ["poetry_core>=1.0.0"] -build-backend = "poetry.core.masonry.api" - - [tool.pyright] -include = ["slate"] -verboseOutput = false +include = [ + "slate", + "slate/objects", + "slate/types", +] pythonVersion = "3.10" typeCheckingMode = "strict" useLibraryCodeForTypes = true