Documentation improvements.

Author: anthony-tuininga

doc/README.md

@@ -15,7 +15,7 @@ To build the documentation locally:
 1. Install Sphinx and the Read the Docs theme using the Python package manager
    ``pip``, for example:
 
-        python -m pip install -r requirements.txt
+        python -m pip install --upgrade -r requirements.txt
 
    You can alternatively install these from pre-built packages for your
    operating system.

doc/src/api_manual/async_connection.rst

@@ -23,7 +23,7 @@ AsyncConnection Class
 
     .. note::
 
-        AsyncConnection objects are only supported in the python-oracledb Thin
+        AsyncConnection objects are only supported in python-oracledb Thin
         mode.
 
     .. note::

doc/src/api_manual/async_connection_pool.rst

@@ -20,8 +20,8 @@ AsyncConnectionPool Class
 
     .. note::
 
-        AsyncConnectionPool objects are only supported in the python-oracledb
-        Thin mode.
+        AsyncConnectionPool objects are only supported in python-oracledb Thin
+        mode.
 
 .. _asynconnpoolmeth:
 

doc/src/api_manual/async_cursor.rst

@@ -20,8 +20,7 @@ AsyncCursor Class
 
     .. note::
 
-        AsyncCursor objects are only supported in the python-oracledb Thin
-        mode.
+        AsyncCursor objects are only supported in python-oracledb Thin mode.
 
 .. _asynccursormeth:
 

doc/src/api_manual/async_lob.rst

@@ -21,7 +21,7 @@ AsyncLOB Class
 
     .. note::
 
-        AsyncLOB objects are only supported in the python-oracledb Thin mode.
+        AsyncLOB objects are only supported in python-oracledb Thin mode.
 
 .. _asynclobmeth:
 

doc/src/api_manual/connection.rst

@@ -422,6 +422,8 @@ Connection Attributes
 
 .. autoproperty:: Connection.thin
 
+    See :ref:`vsessconinfo`.
+
     .. dbapiattributeextension::
 
 .. autoproperty:: Connection.transaction_in_progress

doc/src/api_manual/connection_pool.rst

@@ -17,8 +17,8 @@ ConnectionPool Class
     SessionPool came from the `Oracle Call Interface (OCI) session pool
     <https://www.oracle.com/pls/topic/
     lookup?ctx=dblatest&id=GUID-F9662FFB-EAEF-495C-96FC-49C6D1D9625C>`__. This
-    implementation is only used in the python-oracledb Thick mode and is not
-    available in the Thin mode).
+    implementation is only used in python-oracledb Thick mode and is not
+    available in Thin mode).
 
     .. dbapiobjectextension::
 
@@ -152,6 +152,8 @@ ConnectionPool Attributes
 
 .. autoproperty:: ConnectionPool.thin
 
+    See :ref:`vsessconinfo`.
+
 .. autoproperty:: ConnectionPool.timeout
 
 .. autoproperty:: ConnectionPool.username

doc/src/api_manual/deprecations.rst

@@ -180,7 +180,7 @@ used for new development.
     * - ``Cursor.executemanyprepared()``
       - Use :meth:`Cursor.executemany()` instead.
     * - Previously deprecated Advanced Queuing (AQ) API
-      - Use the new :ref:`AQ API <aq>` instead.  AQ is only available in the python-oracledb Thick mode.
+      - Use the new :ref:`AQ API <aq>` instead.  AQ is only available in python-oracledb Thick mode.
     * - ``Connection.deq()``
       - Replace with :meth:`Queue.deqone()` or :meth:`Queue.deqmany()`
     * - ``Connection.deqoptions()``

doc/src/api_manual/module.rst

@@ -214,6 +214,8 @@ Oracledb Methods
 
 .. autofunction:: is_thin_mode
 
+    See :ref:`vsessconinfo`.
+
     .. dbapimethodextension::
 
     .. versionadded:: 1.1.0

doc/src/api_manual/soda.rst

@@ -14,7 +14,7 @@ JSON strings. See the :ref:`user manual <sodausermanual>` for examples.
 
 .. note::
 
-    SODA is only supported in the python-oracledb Thick mode.  See
+    SODA is only supported in python-oracledb Thick mode.  See
     :ref:`enablingthick`.
 
 .. _sodarequirements:
@@ -30,14 +30,14 @@ DBA:
 
     SQL> grant soda_app, create table to myuser;
 
-Advanced users who are using Oracle sequences for keys will also need the CREATE
-SEQUENCE privilege.
+Advanced users who are using Oracle sequences for keys will also need the
+CREATE SEQUENCE privilege.
 
 SODA requires Oracle Client 18.3 or higher and Oracle Database 18.1 and higher.
 
 .. note::
 
-    SODA APIs are only supported in the python-oracledb Thick mode. See
+    SODA APIs are only supported in python-oracledb Thick mode. See
     :ref:`enablingthick`.
 
 If you are using Oracle Database 21c (or later) and create new collections