From fc1161f34196d47656c28418abccbf4412c263c9 Mon Sep 17 00:00:00 2001 From: Teleport <77507478+teleport2@users.noreply.github.com> Date: Mon, 8 May 2023 23:25:27 +0300 Subject: [PATCH] docs prettify --- README.md | 18 ++++++++++++------ docs/source/conf.py | 1 - docs/source/index.rst | 12 +++++++++++- setup.py | 4 ++-- 4 files changed, 25 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a53145a..69a6b97 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ +[![Documentation Status](https://readthedocs.org/projects/py-spw/badge/?version=latest)](https://pyspw.xstl.ru/ru/latest/?badge=latest) + # Py SPW Library for work with [SPWorlds](https://spworlds.ru) API in Python. ## Installation -Need python version >=3.7 +**You need python >=3.7** ```shell -pip install Py-Spw +pip install Py-SPW ``` -## Quick start +## Getting example *Checking user access* ```python import pyspw @@ -19,10 +21,14 @@ api = pyspw.SpApi(card_id='card_id', print(api.check_access('437610383310716930')) ``` -### How to -You can see [examples](https://github.com/teleportx/Py-SPW/tree/main/examples) to help solve your problem +## Ask help + +* See the code [examples](https://github.com/teleportx/Py-SPW/tree/main/examples) +* If you found a bug in a library report it to [issue tracker](https://github.com/teleportx/Py-SPW/issues) +* Get help with your code using Py-SPW [discussions](https://github.com/teleportx/Py-SPW/discussions) + ## Links - [PyPi](https://pypi.org/project/Py-SPW) -- [Documentation](https://github.com/teleportx/Py-SPW/wiki) +- [Documentation](https://pyspw.xstl.ru/latest) - [API](https://github.com/sp-worlds/api-docs) \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index b1962d5..329b3a6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,7 +39,6 @@ html_sidebars = { "sidebar/brand.html", "sidebar/search.html", "sidebar/navigation.html", - "sidebar/navigation.html", "sidebar/ethical-ads.html", "sidebar/scroll-end.html", ], diff --git a/docs/source/index.rst b/docs/source/index.rst index 63faa98..ae52f06 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,12 +5,22 @@ Py-SPW Documentation Library for work with `SPWorlds `_ API in Python. +Installation +------------ +**You need python >=3.7** + +.. code-block:: shell + + pip install Py-SPW + Getting example =============== +*Checking user access* + .. literalinclude:: ../../examples/check_access.py Ask help -============= +======== * See the code `examples `_ * If you found a bug in a library report it to `issue tracker `_ diff --git a/setup.py b/setup.py index c894f6a..1305d17 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ setup( install_requires=requirements, python_requires='>=3.7', project_urls={ - "Docs": "https://github.com/teleport2/Py-SPW/wiki", - "GitHub": "https://github.com/teleport2/Py-SPW" + "Docs": "https://pyspw.xstl.ru/en/latest/", + "GitHub": "https://github.com/teleport2/Py-SPW/" }, )