Skip to content

Commit 1e048c5

Browse files
KaiSchwarz-cnicKaiSchwarz-cnic
committed
fix(ci): replace m2r (abandoned) with m2r2
1 parent 322ab1c commit 1e048c5

File tree

142 files changed

+26546
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+26546
-1
lines changed

‎docs/_build/html/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: bef6444ecc182b7c4e5b9bb6bfe1674f
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_build/html/_images/hexonet.png‎

1.28 KB
Loading

‎docs/_build/html/_sources/api.rst.txt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _api:
2+
3+
SDK Documentation
4+
=================
5+
6+
Information on specific functions, classes, and methods.
7+
8+
.. toctree::
9+
:glob:
10+
11+
api/*

‎docs/_build/html/_sources/api/hexonet.apiconnector.rst.txt‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
hexonet.apiconnector package
2+
============================
3+
4+
.. automodule:: hexonet.apiconnector
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
13+
.. automodule:: hexonet.apiconnector.apiclient
14+
:members:
15+
:undoc-members:
16+
:show-inheritance:
17+
18+
19+
.. automodule:: hexonet.apiconnector.column
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
25+
.. automodule:: hexonet.apiconnector.customlogger
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
31+
.. automodule:: hexonet.apiconnector.logger
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
37+
.. automodule:: hexonet.apiconnector.record
38+
:members:
39+
:undoc-members:
40+
:show-inheritance:
41+
42+
43+
.. automodule:: hexonet.apiconnector.response
44+
:members:
45+
:undoc-members:
46+
:show-inheritance:
47+
48+
49+
.. automodule:: hexonet.apiconnector.responseparser
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
54+
55+
.. automodule:: hexonet.apiconnector.responsetemplate
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
61+
.. automodule:: hexonet.apiconnector.responsetemplatemanager
62+
:members:
63+
:undoc-members:
64+
:show-inheritance:
65+
66+
67+
.. automodule:: hexonet.apiconnector.socketconfig
68+
:members:
69+
:undoc-members:
70+
:show-inheritance:

‎docs/_build/html/_sources/api/hexonet.rst.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
hexonet package
2+
===============
3+
4+
.. automodule:: hexonet
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Subpackages
10+
-----------
11+
12+
.. toctree::
13+
:maxdepth: 2
14+
15+
hexonet.apiconnector

‎docs/_build/html/_sources/changelog.rst.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _changelog:
2+
3+
Changelog
4+
=========
5+
6+
.. mdinclude:: ../HISTORY.md
7+
.. mdinclude:: ../HISTORY.old.md

‎docs/_build/html/_sources/config.rst.txt‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.. _config:
2+
3+
Configuration Handling
4+
======================
5+
6+
Applications need some kind of configuration. There are different settings
7+
you might want to change depending on the application environment like
8+
toggling the debug mode, setting credentials etc.
9+
10+
The way hexonet.apiconnector is designed usually requires the configuration
11+
to be provided at runtime when connecting to the HEXONET Backend API. You
12+
can hardcode the configuration in the code, which for many small scripts is
13+
for sure sufficient. Realtime applications and frontends need to cover some
14+
application logic around using this SDK like a login form and session
15+
management.
16+
17+
18+
Configuration Basics
19+
--------------------
20+
21+
The configuration can be provided in two ways.
22+
Using the :class:`~hexonet.apiconnector.APIClient`:
23+
24+
.. literalinclude:: app.py
25+
:language: python
26+
:encoding: utf-8
27+
:caption: Python SDK Demo App
28+
29+
Environment and Debug Features
30+
------------------------------
31+
32+
Debug Features are also available in our Python SDK::
33+
34+
# activate debug mode
35+
cl.enableDebugMode()
36+
37+
# disable debug mode
38+
cl.disableDebugMode()
39+
40+
HEXONET provides two different Backend Systems that you might consider to use.
41+
Both require a separate Registration:
42+
- `Live System Registration <https://www.hexonet.net/sign-up>`_ and
43+
- `OT&E System Registration <https://www.hexonet.net/signup-ote>`_.
44+
45+
OT&E System
46+
^^^^^^^^^^^
47+
48+
OT&E Sytem stands for Operational Test & Evaluation System.
49+
No costs, just for playing around with things. This system can be seen as a
50+
kind of sandbox system that allows to test your integration first before going
51+
live with it. This system and the use of our products and services is
52+
completely free of charge.
53+
To use this system, use APIClient's method `cl.useOTESystem()`.
54+
Otherwise Live System will be used by default.
55+
56+
LIVE System
57+
^^^^^^^^^^^
58+
59+
The real world system - This system and the use our services and products can
60+
lead to real costs depending on what you're exactly doing.
61+
Live System will be used by default, but you can also use APIClient's method
62+
`cl.useLIVESystem()` to add it in source code for reference.
63+
64+
Builtin Configuration Values
65+
----------------------------
66+
67+
The following configuration values are used internally by hexonet.apiconnector:
68+
69+
Up to now - none, but this might change in future as we are continously
70+
improving our SDKs.

‎docs/_build/html/_sources/contactus.rst.txt‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _contact-us:
2+
3+
Contact Us
4+
==========
5+
6+
There are several possibilities to get in touch with us, we list them
7+
in our preferred order.
8+
9+
- `Slack`_
10+
11+
- `Stack Overflow`_
12+
13+
- The listed authors in :ref:`authors`
14+
15+
- our `Support`_
16+
17+
.. _Slack: https://hexonet-sdk.slack.com/messages/CBF4RM7KK
18+
.. _Stack Overflow: https://stackoverflow.com/questions/tagged/python-sdk
19+
.. _Support: https://hexonet.support
20+
21+
Please file Bugs / Issues / Problems as `new github issue`_ to us.
22+
Please read our :ref:`contributing` first and use the search to check
23+
if this is already a known issue.
24+
25+
.. _new github issue: https://github.com/hexonet/python-sdk/issues/new

‎docs/_build/html/_sources/contributing.rst.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. _contributing:
2+
3+
.. mdinclude:: ../CONTRIBUTING.md

‎docs/_build/html/_sources/debugging.rst.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. _debugging:
2+
3+
Debugging
4+
=========
5+
6+
Debug Features are also available in our Python SDK::
7+
8+
# activate debug mode
9+
cl.enableDebugMode()
10+
11+
# disable debug mode
12+
cl.disableDebugMode()
13+
14+
This results in displaying the API Connection's used http url,
15+
POST data and plain text response.

0 commit comments

Comments
 (0)