Upload 1.5.0 version

Upload docs
This commit is contained in:
Teleport
2023-05-08 21:43:58 +03:00
parent 852a407ceb
commit 6b771f8925
22 changed files with 676 additions and 367 deletions

73
docs/source/conf.py Normal file

File diff suppressed because one or more lines are too long

25
docs/source/index.rst Normal file
View File

@@ -0,0 +1,25 @@
Py-SPW Documentation
====================
Library for work with `SPWorlds <https://spworlds.ru>`_ API in Python.
Getting example
===============
.. literalinclude:: ../../examples/check_access.py
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>`_
Documentation
=============
.. toctree::
:maxdepth: 3
reference
pyspw

34
docs/source/pyspw.rst Normal file
View File

@@ -0,0 +1,34 @@
pyspw
=====
Api
---
.. automodule:: pyspw.api
:members:
:undoc-members:
:show-inheritance:
User
----
.. automodule:: pyspw.User
:members:
:undoc-members:
:show-inheritance:
Parameters
----------
.. automodule:: pyspw.Parameters
:members:
:undoc-members:
:show-inheritance:
Errors
------
.. automodule:: pyspw.errors
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,8 @@
API Reference
=============
.. automodule:: pyspw.api
:members: SpApi
:undoc-members:
:noindex:
:show-inheritance: