Hugovdberg · Hugovdberg · Aug 4, 2021 · Aug 3, 2021 · Aug 3, 2021 · Aug 3, 2021
diff --git a/PIconnect/PIAF.py b/PIconnect/PIAF.py
@@ -35,10 +35,10 @@
 from warnings import warn
 
 from PIconnect._operators import OPERATORS, add_operators
+from PIconnect._utils import classproperty
 from PIconnect.AFSDK import AF
 from PIconnect.PIData import PISeriesContainer
 from PIconnect.time import timestamp_to_index
-from PIconnect._utils import classproperty
 
 _NOTHING = object()
 

diff --git a/PIconnect/PIConsts.py b/PIconnect/PIConsts.py
@@ -9,7 +9,7 @@
 class UpdateMode(IntEnum):
     """Indicates how to treat duplicate values in the archive, when supported by the Data Reference.
 
-    Detailed information is available at https://techsupport.osisoft.com/Documentation/PI-AF-SDK/html/T_OSIsoft_AF_Data_AFUpdateOption.htm
+    Detailed information is available at https://docs.osisoft.com/bundle/af-sdk/page/html/T_OSIsoft_AF_Data_AFUpdateOption.htm
     """
 
     #: Add the value to the archive.
@@ -36,7 +36,7 @@ class UpdateMode(IntEnum):
 class BufferMode(IntEnum):
     """Indicates buffering option in updating values, when supported by the Data Reference.
 
-    Detailed information is available at https://techsupport.osisoft.com/Documentation/PI-AF-SDK/html/T_OSIsoft_AF_Data_AFBufferOption.htm
+    Detailed information is available at https://docs.osisoft.com/bundle/af-sdk/page/html/T_OSIsoft_AF_Data_AFBufferOption.htm
     """
 
     #: Updating data reference values without buffer.
@@ -52,7 +52,7 @@ class BufferMode(IntEnum):
 class AuthenticationMode(IntEnum):
     """AuthenticationMode indicates how a user authenticates to a PI Server
 
-    Detailed information is available at https://techsupport.osisoft.com/Documentation/PI-AF-SDK/html/T_OSIsoft_AF_PI_PIAuthenticationMode.htm
+    Detailed information is available at https://docs.osisoft.com/bundle/af-sdk/page/html/T_OSIsoft_AF_PI_PIAuthenticationMode.htm
     """
 
     #: Use Windows authentication when making a connection
@@ -64,7 +64,7 @@ class AuthenticationMode(IntEnum):
 class CalculationBasis(IntEnum):
     """CalculationBasis indicates how values should be weighted over a time range
 
-    Detailed information is available at https://techsupport.osisoft.com/Documentation/PI-AF-SDK/html/T_OSIsoft_AF_Data_AFCalculationBasis.htm
+    Detailed information is available at https://docs.osisoft.com/bundle/af-sdk/page/html/T_OSIsoft_AF_Data_AFCalculationBasis.htm
     """
 
     #: Each event is weighted according to the time over which it applies.
@@ -86,7 +86,7 @@ class CalculationBasis(IntEnum):
 class ExpressionSampleType(IntEnum):
     """ExpressionSampleType indicates how expressions are evaluated over a time range.
 
-    Detailed information is available at https://techsupport.osisoft.com/Documentation/PI-AF-SDK/html/T_OSIsoft_AF_Data_AFSampleType.htm
+    Detailed information is available at https://docs.osisoft.com/bundle/af-sdk/page/html/T_OSIsoft_AF_Data_AFSampleType.htm
     """
 
     #: The expression is evaluated at each archive event.
@@ -106,7 +106,7 @@ class SummaryType(IntFlag):
     <SummaryType.MAXIMUM|MINIMUM: 12>  # On Python 3.6+
     12  # On previous versions
 
-    Detailed information is available at https://techsupport.osisoft.com/Documentation/PI-AF-SDK/html/T_OSIsoft_AF_Data_AFSummaryTypes.htm
+    Detailed information is available at https://docs.osisoft.com/bundle/af-sdk/page/html/T_OSIsoft_AF_Data_AFSummaryTypes.htm
     """
 
     #: No summary data
@@ -141,7 +141,7 @@ class TimestampCalculation(IntEnum):
     """
     TimestampCalculation defines the timestamp returned for a given summary calculation
 
-    Detailed information is available at https://techsupport.osisoft.com/Documentation/PI-AF-SDK/html/T_OSIsoft_AF_Data_AFTimestampCalculation.htm
+    Detailed information is available at https://docs.osisoft.com/bundle/af-sdk/page/html/T_OSIsoft_AF_Data_AFTimestampCalculation.htm
     """
 
     #: The timestamp is the event time of the minimum or maximum for those summaries or the beginning of the interval otherwise.

diff --git a/PIconnect/time.py b/PIconnect/time.py
@@ -1,20 +1,27 @@
 from datetime import datetime
+
 import pytz
 
 from PIconnect.AFSDK import AF
 from PIconnect.config import PIConfig
 
 
 def to_af_time_range(start_time, end_time):
-    """to_af_time_range
+    """Convert a combination of start and end time to a time range.
 
-    Return AF.Time.AFTimeRange object from datetime or string
-    using :afsdk:`AF.Time.AFTimeRange <M_OSIsoft_AF_Time_AFTimeRange__ctor_1.htm>`.
+    Both `start_time` and `end_time` can be either a :any:`datetime.datetime` object or a string.
+    `datetime` objects are first converted to a string, before being passed to
+    :afsdk:`AF.Time.AFTimeRange <M_OSIsoft_AF_Time_AFTimeRange__ctor_1.htm>`. It is also
+    possible to specify either end as a `datetime` object, and then specify the other
+    boundary as a relative string.
 
-    If string is used, it is assumed that user knows the format
-    that should be passed to AF.Time.AFTimeRange.
-    """
+    Args:
+        start_time (str | datetime): Start time of the time range.
+        end_time (str | datetime): End time of the time range.
 
+    Returns:
+        :afsdk:`AF.Time.AFTimeRange <M_OSIsoft_AF_Time_AFTimeRange__ctor_1.htm>`: Time range covered by the start and end time.
+    """
     if isinstance(start_time, datetime):
         start_time = start_time.isoformat()
     if isinstance(end_time, datetime):
@@ -26,12 +33,11 @@ def to_af_time_range(start_time, end_time):
 def timestamp_to_index(timestamp):
     """Convert AFTime object to datetime in local timezone.
 
-    .. todo::
-
-        Allow to define timezone, default to UTC?
-
-    .. todo::
+    Args:
+        timestamp (`System.DateTime`): Timestamp in .NET format to convert to `datetime`.
 
+    Returns:
+        `datetime`: Datetime with the timezone info from :data:`PIConfig.DEFAULT_TIMEZONE <PIconnect.config.PIConfigContainer.DEFAULT_TIMEZONE>`.
     """
     local_tz = pytz.timezone(PIConfig.DEFAULT_TIMEZONE)
     return (

diff --git a/docs/PIconnect.PI.rst b/docs/PIconnect.PI.rst
diff --git a/docs/PIconnect.rst b/docs/PIconnect.rst
diff --git a/docs/api/PI/PIconnect.PI.rst b/docs/api/PI/PIconnect.PI.rst
@@ -0,0 +1,21 @@
+PIconnect.PI module
+===================
+
+.. autoclass:: PIconnect.PI.PIServer
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :exclude-members: servers, default_server
+
+    .. autoattribute:: servers
+        :annotation: Dictionary of known servers, as reported by the SDK
+
+    .. autoattribute:: default_server
+        :annotation: Default server, as reported by the SDK
+
+.. autoclass:: PIconnect.PI.PIPoint
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/api/PIAF/PIconnect.PIAF.rst b/docs/api/PIAF/PIconnect.PIAF.rst
@@ -0,0 +1,27 @@
+PIconnect.PIAF module
+=====================
+
+.. autoclass:: PIconnect.PIAF.PIAFDatabase
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+    :exclude-members: servers, default_server
+
+    .. autoattribute:: servers
+        :annotation: Dictionary of known servers, as reported by the SDK
+
+    .. autoattribute:: default_server
+        :annotation: Default server, as reported by the SDK
+
+.. autoclass:: PIconnect.PIAF.PIAFElement
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
+
+.. autoclass:: PIconnect.PIAF.PIAFAttribute
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/PIconnect.AFSDK.rst → docs/api/PIconnect.AFSDK.rst b/docs/PIconnect.AFSDK.rst → docs/api/PIconnect.AFSDK.rst
diff --git a/docs/PIconnect.PIConsts.rst → docs/api/PIconnect.PIConsts.rst b/docs/PIconnect.PIConsts.rst → docs/api/PIconnect.PIConsts.rst
diff --git a/docs/PIconnect.PIData.rst → docs/api/PIconnect.PIData.rst b/docs/PIconnect.PIData.rst → docs/api/PIconnect.PIData.rst
diff --git a/docs/PIconnect.config.rst → docs/api/PIconnect.config.rst b/docs/PIconnect.config.rst → docs/api/PIconnect.config.rst
diff --git a/docs/PIconnect.PIAF.rst → docs/api/PIconnect.time.rst b/docs/PIconnect.PIAF.rst → docs/api/PIconnect.time.rst
@@ -1,7 +1,7 @@
-PIconnect.PIAF module
+PIconnect.time module
 =====================
 
-.. automodule:: PIconnect.PIAF
+.. automodule:: PIconnect.time
     :members:
     :undoc-members:
     :inherited-members:

diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,35 @@
+API Reference
+=============
+
+.. automodule:: PIconnect
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+PI Data Archive related modules
+-------------------------------
+
+.. toctree::
+   :maxdepth: 4
+   :glob:
+
+   ./PI/*
+
+PI Asset Framework related modules
+----------------------------------
+
+.. toctree::
+   :maxdepth: 4
+   :glob:
+
+   ./PIAF/*
+
+Generic utility modules
+-----------------------
+
+.. toctree::
+   :maxdepth: 4
+   :glob:
+
+   ./*
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,9 +20,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import PIconnect
-
-# sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 
 class Mock(MagicMock):
@@ -35,14 +33,15 @@ def __getattr__(cls, name):
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
 
 # Get the project root dir, which is the parent dir of this
-cwd = os.getcwd()
-project_root = os.path.dirname(cwd)
+# cwd = os.getcwd()
+# project_root = os.path.dirname(cwd)
 
 # Insert the project root dir as the first element in the PYTHONPATH.
 # This lets us ensure that the source package is imported, and that its
 # version is used.
-sys.path.insert(0, project_root)
+# sys.path.insert(0, project_root)
 
+import PIconnect
 
 # -- General configuration ---------------------------------------------
 
@@ -55,6 +54,7 @@ def __getattr__(cls, name):
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
     "sphinx.ext.todo",
     "sphinx.ext.coverage",
     "sphinx.ext.githubpages",
@@ -89,12 +89,11 @@ def __getattr__(cls, name):
 # The full version, including alpha/beta/rc tags.
 release = PIconnect.__version__
 
-extlinks = {
-    "afsdk": ("https://techsupport.osisoft.com/Documentation/PI-AF-SDK/html/%s", "")
-}
+extlinks = {"afsdk": ("https://docs.osisoft.com/bundle/af-sdk/page/html/%s", "")}
 
 intersphinx_mapping = {
-    "pandas": ("http://pandas.pydata.org/docs", None),
+    "python": ("https://docs.python.org/3.8", None),
+    "pandas": ("https://pandas.pydata.org/docs", None),
     "pytz": ("http://pytz.sourceforge.net", None),
 }
 
@@ -116,7 +115,7 @@ def __getattr__(cls, name):
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
-
+autosummary_generate = True
 # -- Options for HTML output ----------------------------------------------
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -14,7 +14,7 @@ structure:
 - The basic introductions to using :py:mod:`PIconnect` are covered in the
   :doc:`/tutorials`.
 - The technical reference to all modules within :py:mod:`PIconnect` are
-  covered in :doc:`/modules`. These also include several links to the original
+  covered in :doc:`/api/index`. These also include several links to the original
   SDK documentation for important implementation details.
 - Background explanations and how-to guides still need to be written.
 
@@ -26,7 +26,7 @@ Contents
 
    installation
    tutorials
-   modules
+   api/index
    contributing
    authors
    history

diff --git a/docs/modules.rst b/docs/modules.rst
diff --git a/docs/tutorials.rst b/docs/tutorials.rst
@@ -21,3 +21,4 @@ Data extraction
    tutorials/interpolated_values
    tutorials/summaries
    tutorials/timezones
+   tutorials/update_value
diff --git a/docs/tutorials/update_value.rst b/docs/tutorials/update_value.rst
@@ -15,6 +15,7 @@ buffer_option as AFBufferOption.
 
 
 .. code-block:: python
+
     from datetime import datetime
     import pytz
     import PIconnect as PI