diff --git a/docs/src/index.rst b/docs/src/index.rst index 0a00fb990..d3fa72760 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -15,6 +15,7 @@ branch of Rogue. New documentation is being added incrementally over time. :caption: Contents: installing/index + pyrogue_tree/index interfaces/index utilities/index hardware/index diff --git a/docs/src/pyrogue_tree/index.rst b/docs/src/pyrogue_tree/index.rst new file mode 100644 index 000000000..0b8c09e6a --- /dev/null +++ b/docs/src/pyrogue_tree/index.rst @@ -0,0 +1,14 @@ +.. _pyrogue_tree: + +================ +PyRogue Tree +================ + +The PyRogue Tree implements a tree structure for the hierarchical organization of devices ... + +.. toctree:: + :maxdepth: 1 + :caption: Using Nodes In The PyRogue Tree: + + node/index + diff --git a/docs/src/pyrogue_tree/node/command/index.rst b/docs/src/pyrogue_tree/node/command/index.rst new file mode 100644 index 000000000..bc0eecac0 --- /dev/null +++ b/docs/src/pyrogue_tree/node/command/index.rst @@ -0,0 +1,49 @@ +.. _pyrogue_tree_node_command: + +======= +Command +======= + +The Command class ... + +In this example ... + +Python Command Example +====================== + +Below is an example of creating a Command which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a command + class MyCommand(...): + +C++ Command Example +=================== + +Below is an example of creating a Command device in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a command + class MyCommand : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... + +.. toctree:: + :maxdepth: 1 + :caption: Types Of Commands In The PyRogue Tree: + + local_command/index + remote_command/index + diff --git a/docs/src/pyrogue_tree/node/command/local_command/index.rst b/docs/src/pyrogue_tree/node/command/local_command/index.rst new file mode 100644 index 000000000..f6bf2179e --- /dev/null +++ b/docs/src/pyrogue_tree/node/command/local_command/index.rst @@ -0,0 +1,42 @@ +.. _pyrogue_tree_node_command_local_command: + +============ +LocalCommand +============ + +The LocalCommand class ... + +In this example ... + +Python LocalCommand Example +=========================== + +Below is an example of creating a LocalCommand which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a LocalCommand + class MyLocalCommand(...): + +C++ LocalCommand Example +======================== + +Below is an example of creating a LocalCommand device in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a LocalCommand + class MyLocalCommand : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... + diff --git a/docs/src/pyrogue_tree/node/command/remote_command/index.rst b/docs/src/pyrogue_tree/node/command/remote_command/index.rst new file mode 100644 index 000000000..9d59642b0 --- /dev/null +++ b/docs/src/pyrogue_tree/node/command/remote_command/index.rst @@ -0,0 +1,42 @@ +.. _pyrogue_tree_node_command_remote_command: + +============= +RemoteCommand +============= + +The RemoteCommand class ... + +In this example ... + +Python RemoteCommand Example +============================ + +Below is an example of creating a RemoteCommand which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a RemoteCommand + class MyRemoteCommand(...): + +C++ RemoteCommand Example +========================= + +Below is an example of creating a RemoteCommand device in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a RemoteCommand + class MyRemoteCommand : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... + diff --git a/docs/src/pyrogue_tree/node/device/index.rst b/docs/src/pyrogue_tree/node/device/index.rst new file mode 100644 index 000000000..6764b04a6 --- /dev/null +++ b/docs/src/pyrogue_tree/node/device/index.rst @@ -0,0 +1,42 @@ +.. _pyrogue_tree_node_device: + +====== +Device +====== + +The Device class ... + +In this example ... + +Python Device Example +===================== + +Below is an example of creating a Device which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a Device + class MyDevice(...): + +C++ Device Example +================== + +Below is an example of creating a Device class in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a Device + class MyDevice : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... + diff --git a/docs/src/pyrogue_tree/node/index.rst b/docs/src/pyrogue_tree/node/index.rst new file mode 100644 index 000000000..0fe0d2124 --- /dev/null +++ b/docs/src/pyrogue_tree/node/index.rst @@ -0,0 +1,17 @@ +.. _pyrogue_tree_node: + +==== +Node +==== + +The Node class is the base class of all devices ... + +.. toctree:: + :maxdepth: 1 + :caption: Types Of Nodes In The PyRogue Tree: + + root/index + device/index + command/index + variable/index + diff --git a/docs/src/pyrogue_tree/node/root/index.rst b/docs/src/pyrogue_tree/node/root/index.rst new file mode 100644 index 000000000..4f344bbcf --- /dev/null +++ b/docs/src/pyrogue_tree/node/root/index.rst @@ -0,0 +1,42 @@ +.. _pyrogue_tree_node_root: + +==== +Root +==== + +The Root class ... + +In this example ... + +Python Root Example +=================== + +Below is an example of creating a root which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a root + class MyRoot(...): + +C++ Root Example +================ + +Below is an example of creating a root device in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a root + class MyRoot : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... + diff --git a/docs/src/pyrogue_tree/node/variable/index.rst b/docs/src/pyrogue_tree/node/variable/index.rst new file mode 100644 index 000000000..7a3bd359b --- /dev/null +++ b/docs/src/pyrogue_tree/node/variable/index.rst @@ -0,0 +1,49 @@ +.. _pyrogue_tree_node_variable: + +======== +Variable +======== + +The Variable class ... + +In this example ... + +Python Variable Example +======================= + +Below is an example of creating a Variable which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a Variable + class MyVariable(...): + +C++ Variable Example +==================== + +Below is an example of creating a Variable device in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a Variable + class MyVariable : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... + +.. toctree:: + :maxdepth: 1 + :caption: Types Of Variables In The PyRogue Tree: + + link_variable/index + local_variable/index + remote_variable/index diff --git a/docs/src/pyrogue_tree/node/variable/link_variable/index.rst b/docs/src/pyrogue_tree/node/variable/link_variable/index.rst new file mode 100644 index 000000000..5cf1d2b68 --- /dev/null +++ b/docs/src/pyrogue_tree/node/variable/link_variable/index.rst @@ -0,0 +1,42 @@ +.. _pyrogue_tree_node_variable_link_variable: + +============ +LinkVariable +============ + +The LinkVariable class ... + +In this example ... + +Python LinkVariable Example +=========================== + +Below is an example of creating a LinkVariable which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a LinkVariable + class MyLinkVariable(...): + +C++ LinkVariable Example +======================== + +Below is an example of creating a LinkVariable device in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a LinkVariable + class MyLinkVariable : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... + diff --git a/docs/src/pyrogue_tree/node/variable/local_variable/index.rst b/docs/src/pyrogue_tree/node/variable/local_variable/index.rst new file mode 100644 index 000000000..df71bf319 --- /dev/null +++ b/docs/src/pyrogue_tree/node/variable/local_variable/index.rst @@ -0,0 +1,42 @@ +.. _pyrogue_tree_node_variable_local_variable: + +============= +LocalVariable +============= + +The LocalVariable class ... + +In this example ... + +Python LocalVariable Example +============================ + +Below is an example of creating a LocalVariable which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a LocalVariable + class MyLocalVariable(...): + +C++ LocalVariable Example +========================= + +Below is an example of creating a LocalVariable device in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a LocalVariable + class MyLocalVariable : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... + diff --git a/docs/src/pyrogue_tree/node/variable/remote_variable/index.rst b/docs/src/pyrogue_tree/node/variable/remote_variable/index.rst new file mode 100644 index 000000000..1e38d8268 --- /dev/null +++ b/docs/src/pyrogue_tree/node/variable/remote_variable/index.rst @@ -0,0 +1,42 @@ +.. _pyrogue_tree_node_variable_remote_variable: + +============== +RemoteVariable +============== + +The RemoteVariable class ... + +In this example ... + +Python RemoteVariable Example +============================= + +Below is an example of creating a RemoteVariable which ... + +.. code-block:: python + + import pyrogue + + # Create a subclass of a RemoteVariable + class MyRemoteVariable(...): + +C++ RemoteVariable Example +========================== + +Below is an example of creating a RemoteVariable device in C++. + +.. code-block:: c + + #include + #include + + // Create a subclass of a RemoteVariable + class MyRemoteVariable : public rogue:: ... { + public: + + protected: + + }; + +A few notes on the above examples ... +