mirror of
https://github.com/yawaflua/Py-SPW.git
synced 2025-12-10 12:29:30 +02:00
Upload 1.5.0 version
Upload docs
This commit is contained in:
73
docs/source/conf.py
Normal file
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
25
docs/source/index.rst
Normal 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
34
docs/source/pyspw.rst
Normal 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:
|
||||
8
docs/source/reference.rst
Normal file
8
docs/source/reference.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
API Reference
|
||||
=============
|
||||
|
||||
.. automodule:: pyspw.api
|
||||
:members: SpApi
|
||||
:undoc-members:
|
||||
:noindex:
|
||||
:show-inheritance:
|
||||
Reference in New Issue
Block a user