Documentation version 0.6.0

Author: Synaptics GitLab CI

docs/README.md

@@ -4,7 +4,7 @@ DL-7450 SDK Documentation
 Building the documentation locally
 ----------------------------------
 
-If you're making changes to the documentation, you may want to build the
+If you are making changes to the documentation, you may want to build the
 documentation locally so that you can preview your changes.
 
 Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme.

docs/conf.py

@@ -13,8 +13,9 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
+import sys
+from datetime import datetime
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -66,7 +67,7 @@
 
 # General information about the project.
 project = "DisplayLink DL-7450 SDK"
-copyright = "- The DisplayLink DL-7450 SDK Documentation is Copyright © 2024 Synaptics Inc."
+copyright = f"- The DisplayLink DL-7450 SDK Documentation is Copyright © 2024-{datetime.now().year} Synaptics Inc."
 version = release = dl7450_version
 
 exclude_patterns = ["build", ".venv", "venv"]
@@ -180,9 +181,6 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = "DL7450doc"
 
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {"python": ("https://docs.python.org/3.5", None)}
-
 # External weblinks
 extlinks = {
     "githubSamples": ('https://github.com/DisplayLink/dl-7450/tree/main/%s', None)

docs/library/builtins.rst

@@ -4,6 +4,17 @@
 All builtin functions and exceptions are described here. They are also
 available via ``builtins`` module.
 
+Constants
+---------
+
+.. data:: True
+
+.. data:: False
+
+.. data:: None
+
+.. data:: NotImplemented
+
 Functions and types
 -------------------
 
@@ -33,8 +44,8 @@ Functions and types
 
 .. function:: delattr(obj, name)
 
-   The argument *name* should be a string, and this function deletes the named
-   attribute from the object given by *obj*.
+  The argument *name* should be a string, and this function deletes the named
+  attribute from the object given by *obj*.
 
 .. class:: dict()
 
@@ -70,15 +81,15 @@ Functions and types
 
 .. class:: int()
 
-   .. classmethod:: from_bytes(bytes, byteorder)
+  .. classmethod:: from_bytes(bytes, byteorder)
 
-      The *byteorder* parameter must be positional (this is
-      compatible with CPython).
+    The *byteorder* parameter must be positional (this is
+    compatible with CPython).
 
-   .. method:: to_bytes(size, byteorder)
+  .. method:: to_bytes(size, byteorder)
 
-      The *byteorder* parameter must be positional (this is
-      compatible with CPython).
+    The *byteorder* parameter must be positional (this is
+    compatible with CPython).
 
 .. function:: isinstance()
 
@@ -130,7 +141,7 @@ Functions and types
 
 .. class:: slice()
 
-   The *slice* builtin is the type that slice objects have.
+  The *slice* builtin is the type that slice objects have.
 
 .. function:: sorted()
 

docs/library/datetime.date.rst

@@ -4,78 +4,122 @@
 class date -- Represent a date
 ===============================
 
+A representation of a date, according to the Gregorian calendar.
+
 :py:class:`~datetime.date` objects support equality and comparison operators.
 
 .. class:: date(year, month, day)
 
-  All arguments are required. Arguments must be integers, in the following ranges:
+  Construct a date object representing the given ``year``, ``month`` and ``day``.
 
-    - :py:class:`~datetime.MINYEAR` <= year <= :py:class:`~datetime.MAXYEAR`
-    - 1 <= month <= 12
-    - 1 <= day <= number of days in the given month and year
+  Arguments must be integers in the following ranges:
 
-  Other constructors:
+    - :py:class:`~datetime.MINYEAR` <= ``year`` <= :py:class:`~datetime.MAXYEAR`
+    - ``1`` <= ``month`` <= ``12``
+    - ``1`` <= ``day`` <= number of days in the given month and year
 
   .. classmethod:: today()
 
+    Construct a date object representing today's year, month and day.
+
   .. classmethod:: fromtimestamp(timestamp)
 
+    Construct a date object representing the year, month and day specified by the
+    provided ``timestamp``.
+
+    A ``timestamp`` in this case is a floating point number representing the
+    number of seconds since the epoch (January 1, 1970, 00:00:00 UTC).
+
   .. classmethod:: fromordinal(ordinal)
 
-  .. classmethod:: fromisoformate(date_string)
+    Construct a date object representing the year, month and day specified by the
+    provided ``ordinal``.
+
+    An ``ordinal`` is an integer representing the number of days since January
+    1st of year 1.
+
+  .. classmethod:: fromisoformat(date_string)
+
+    Construct a date object from a string in
+    `ISO 8601 format <https://www.iso.org/iso-8601-date-and-time-format.html>`_::
+
+        from datetime import date
+        d = date.fromisoformat('2012-12-21')
 
-  Class attributes:
-  
   .. attribute:: min
 
-    The earliest representable date, date(:py:attr:`~datetime.MINYEAR`, 1, 1).
+    The earliest representable date, ``date(datetime.MINYEAR, 1, 1)``.
 
   .. attribute:: max
 
-    The latest representable date, date(:py:attr:`~datetime.MAXYEAR`, 12, 31).
+    The latest representable date, ``date(datetime.MAXYEAR, 12, 31)``.
 
   .. attribute:: resolution
 
-    The smallest possible difference between non-equal date objects, ``timedelta(days=1)`` .
-
-  Instance attributes:
+    The smallest possible difference between non-equal date objects,
+    ``timedelta(days=1)``.
 
   .. attribute:: year
 
+    The year of the date, an integer in the range :py:class:`~datetime.MINYEAR`
+    to :py:class:`~datetime.MAXYEAR`.
+
   .. attribute:: month
 
+    The month of the date, an integer in the range ``1`` to ``12``.
+
   .. attribute:: day
 
-  Instance methods
+    The day of the date, an integer in the range ``1`` to the number of days
+    in the month represented by :py:attr:`month`.
 
   .. method:: replace(year = self.year, month = self.month, day = self.day)
 
-    Return a new :py:class:`~datetime.date` object with the same values but the specified parameters updated.
+    Return a new :py:class:`~datetime.date` object with the same values as the
+    existing date object, but with the specified parameters updated.
 
   .. method:: tuple()
 
-    Return the date as a tuple (year, month, day)
+    Return the date as a 3-tuple ``(year, month, day)``.
 
   .. method:: timetuple()
 
     Return the date as a 9-tuple
+    ``(year, month, day, hour, minute, second, weekday, yearday, dst)``, as
+    described in :py:meth:`datetime.datetime.timetuple`.
+
+    In this case:
+
+    * ``hour``, ``minute`` and ``second`` are all ``0``, as the date object does
+      not contain time information.
+    * ``weekday`` is the day of the week as an integer, where Monday is ``0`` and
+      Sunday is ``6``.
+    * ``yearday`` is the day of the year as an integer, where January 1st is
+      ``1``.
+    * ``dst`` is ``-1``, as the date object does not contain daylight savings
+      information.
 
   .. method:: toordinal()
-    
-    Return an integer representing the ordinal of the date, where January 1st of year 1 has ordinal 1.
+
+    Return an integer representing the ordinal of the date, where January 1st
+    of year 1 has ordinal ``1``.
 
   .. method:: isoformat()
 
-    Return a string representing the date in ISO 8601 format, YYYY-MM-DD::
+    Return a string representing the date in
+    `ISO 8601 format <https://www.iso.org/iso-8601-date-and-time-format.html>`_,
+    ``YYYY-MM-DD``::
 
         from datetime import date
         date(2002, 12, 4).isoformat()
         # outputs '2002-12-04'
 
   .. method:: isoweekday()
 
-    Return the day of the week as an integer, where Monday is 1 and Sunday is 7.
+    Return the day of the week as an integer, where Monday is ``1`` and Sunday is
+    ``7``.
 
   .. method:: weekday()
 
-    Return the day of the week as an integer, where Monday is 0 and Sunday is 6. 
+    Return the day of the week as an integer, where Monday is ``0`` and Sunday is
+    ``6``.