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

20
docs/Makefile Normal file
View File

@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

35
docs/make.bat Normal file
View File

@@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

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: