1
0
mirror of https://github.com/FreeOpcUa/opcua-asyncio synced 2025-10-29 17:07:18 +08:00

added doc autogenerated with sphinx-apidoc -o docs opcua

This commit is contained in:
olivier R-D
2016-01-30 10:19:57 +01:00
parent 583b67c14d
commit ca56e983f0
10 changed files with 448 additions and 20 deletions

View File

@@ -33,8 +33,11 @@ Contents:
client
node
subscription
errors
ua
opcua
All:
modules
Indices and tables
==================

7
docs/modules.rst Normal file
View File

@@ -0,0 +1,7 @@
opcua
=====
.. toctree::
:maxdepth: 4
opcua

30
docs/opcua.client.rst Normal file
View File

@@ -0,0 +1,30 @@
opcua.client package
====================
Submodules
----------
opcua.client.client module
--------------------------
.. automodule:: opcua.client.client
:members:
:undoc-members:
:show-inheritance:
opcua.client.ua_client module
-----------------------------
.. automodule:: opcua.client.ua_client
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: opcua.client
:members:
:undoc-members:
:show-inheritance:

94
docs/opcua.common.rst Normal file
View File

@@ -0,0 +1,94 @@
opcua.common package
====================
Submodules
----------
opcua.common.event module
-------------------------
.. automodule:: opcua.common.event
:members:
:undoc-members:
:show-inheritance:
opcua.common.instanciate module
-------------------------------
.. automodule:: opcua.common.instanciate
:members:
:undoc-members:
:show-inheritance:
opcua.common.manage_nodes module
--------------------------------
.. automodule:: opcua.common.manage_nodes
:members:
:undoc-members:
:show-inheritance:
opcua.common.methods module
---------------------------
.. automodule:: opcua.common.methods
:members:
:undoc-members:
:show-inheritance:
opcua.common.node module
------------------------
.. automodule:: opcua.common.node
:members:
:undoc-members:
:show-inheritance:
opcua.common.subscription module
--------------------------------
.. automodule:: opcua.common.subscription
:members:
:undoc-members:
:show-inheritance:
opcua.common.uaerrors module
----------------------------
.. automodule:: opcua.common.uaerrors
:members:
:undoc-members:
:show-inheritance:
opcua.common.utils module
-------------------------
.. automodule:: opcua.common.utils
:members:
:undoc-members:
:show-inheritance:
opcua.common.xmlimporter module
-------------------------------
.. automodule:: opcua.common.xmlimporter
:members:
:undoc-members:
:show-inheritance:
opcua.common.xmlparser module
-----------------------------
.. automodule:: opcua.common.xmlparser
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: opcua.common
:members:
:undoc-members:
:show-inheritance:

30
docs/opcua.crypto.rst Normal file
View File

@@ -0,0 +1,30 @@
opcua.crypto package
====================
Submodules
----------
opcua.crypto.security_policies module
-------------------------------------
.. automodule:: opcua.crypto.security_policies
:members:
:undoc-members:
:show-inheritance:
opcua.crypto.uacrypto module
----------------------------
.. automodule:: opcua.crypto.uacrypto
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: opcua.crypto
:members:
:undoc-members:
:show-inheritance:

33
docs/opcua.rst Normal file
View File

@@ -0,0 +1,33 @@
opcua package
=============
Subpackages
-----------
.. toctree::
opcua.client
opcua.common
opcua.crypto
opcua.server
opcua.ua
Submodules
----------
opcua.tools module
------------------
.. automodule:: opcua.tools
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: opcua
:members:
:undoc-members:
:show-inheritance:

93
docs/opcua.server.rst Normal file
View File

@@ -0,0 +1,93 @@
opcua.server package
====================
Subpackages
-----------
.. toctree::
opcua.server.standard_address_space
Submodules
----------
opcua.server.address_space module
---------------------------------
.. automodule:: opcua.server.address_space
:members:
:undoc-members:
:show-inheritance:
opcua.server.binary_server module
---------------------------------
.. automodule:: opcua.server.binary_server
:members:
:undoc-members:
:show-inheritance:
opcua.server.binary_server_asyncio module
-----------------------------------------
.. automodule:: opcua.server.binary_server_asyncio
:members:
:undoc-members:
:show-inheritance:
opcua.server.internal_server module
-----------------------------------
.. automodule:: opcua.server.internal_server
:members:
:undoc-members:
:show-inheritance:
opcua.server.internal_subscription module
-----------------------------------------
.. automodule:: opcua.server.internal_subscription
:members:
:undoc-members:
:show-inheritance:
opcua.server.server module
--------------------------
.. automodule:: opcua.server.server
:members:
:undoc-members:
:show-inheritance:
opcua.server.subscription_service module
----------------------------------------
.. automodule:: opcua.server.subscription_service
:members:
:undoc-members:
:show-inheritance:
opcua.server.uaprocessor module
-------------------------------
.. automodule:: opcua.server.uaprocessor
:members:
:undoc-members:
:show-inheritance:
opcua.server.users module
-------------------------
.. automodule:: opcua.server.users
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: opcua.server
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,86 @@
opcua.server.standard_address_space package
===========================================
Submodules
----------
opcua.server.standard_address_space.standard_address_space module
-----------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space
:members:
:undoc-members:
:show-inheritance:
opcua.server.standard_address_space.standard_address_space_part10 module
------------------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space_part10
:members:
:undoc-members:
:show-inheritance:
opcua.server.standard_address_space.standard_address_space_part11 module
------------------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space_part11
:members:
:undoc-members:
:show-inheritance:
opcua.server.standard_address_space.standard_address_space_part13 module
------------------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space_part13
:members:
:undoc-members:
:show-inheritance:
opcua.server.standard_address_space.standard_address_space_part3 module
-----------------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space_part3
:members:
:undoc-members:
:show-inheritance:
opcua.server.standard_address_space.standard_address_space_part4 module
-----------------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space_part4
:members:
:undoc-members:
:show-inheritance:
opcua.server.standard_address_space.standard_address_space_part5 module
-----------------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space_part5
:members:
:undoc-members:
:show-inheritance:
opcua.server.standard_address_space.standard_address_space_part8 module
-----------------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space_part8
:members:
:undoc-members:
:show-inheritance:
opcua.server.standard_address_space.standard_address_space_part9 module
-----------------------------------------------------------------------
.. automodule:: opcua.server.standard_address_space.standard_address_space_part9
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: opcua.server.standard_address_space
:members:
:undoc-members:
:show-inheritance:

70
docs/opcua.ua.rst Normal file
View File

@@ -0,0 +1,70 @@
opcua.ua package
================
Submodules
----------
opcua.ua.attribute_ids module
-----------------------------
.. automodule:: opcua.ua.attribute_ids
:members:
:undoc-members:
:show-inheritance:
opcua.ua.extension_objects module
---------------------------------
.. automodule:: opcua.ua.extension_objects
:members:
:undoc-members:
:show-inheritance:
opcua.ua.object_ids module
--------------------------
.. automodule:: opcua.ua.object_ids
:members:
:undoc-members:
:show-inheritance:
opcua.ua.status_codes module
----------------------------
.. automodule:: opcua.ua.status_codes
:members:
:undoc-members:
:show-inheritance:
opcua.ua.uaprotocol_auto module
-------------------------------
.. automodule:: opcua.ua.uaprotocol_auto
:members:
:undoc-members:
:show-inheritance:
opcua.ua.uaprotocol_hand module
-------------------------------
.. automodule:: opcua.ua.uaprotocol_hand
:members:
:undoc-members:
:show-inheritance:
opcua.ua.uatypes module
-----------------------
.. automodule:: opcua.ua.uatypes
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: opcua.ua
:members:
:undoc-members:
:show-inheritance:

View File

@@ -1,18 +0,0 @@
UA Structures and Enums
=========================================
All the structures and enums are to be found under opcua.ua
.. automodule:: opcua.ua.uatypes
:members:
.. automodule:: opcua.ua.uaprotocol_hand
:members:
.. automodule:: opcua.ua.uaprotocol_auto
:members: