Skip to content

Commit 8af7d76

Browse files
Start process of migrating API documentation to source code.
1 parent 4b7be11 commit 8af7d76

File tree

10 files changed

+2603
-3504
lines changed

10 files changed

+2603
-3504
lines changed

doc/src/api_manual/async_connection.rst

Lines changed: 87 additions & 592 deletions
Large diffs are not rendered by default.

doc/src/api_manual/async_cursor.rst

Lines changed: 55 additions & 472 deletions
Large diffs are not rendered by default.

doc/src/api_manual/connection.rst

Lines changed: 101 additions & 739 deletions
Large diffs are not rendered by default.

doc/src/api_manual/cursor.rst

Lines changed: 60 additions & 491 deletions
Large diffs are not rendered by default.

doc/src/api_manual/module.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2154,13 +2154,6 @@ Oracledb Methods
21542154

21552155
The ``connection_id_prefix`` parameter was added.
21562156

2157-
.. function:: Cursor(connection)
2158-
2159-
Constructor for creating a cursor. Returns a new
2160-
:ref:`cursor object <cursorobj>` using the connection.
2161-
2162-
.. dbapimethodextension::
2163-
21642157
.. function:: Date(year, month, day)
21652158

21662159
Constructs an object holding a date value.

doc/src/conf.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@
1212
# serve to show the default value.
1313

1414
import os
15+
import pathlib
1516
import sys
1617

1718
# If your extensions are in another directory, add it here.
1819
sys.path.append(os.path.abspath("_ext"))
1920

21+
# include the path of the source so that autodoc willfunction
22+
sys.path.insert(0, str(pathlib.Path("..", "src").resolve()))
23+
2024
# General configuration
2125
# ---------------------
2226

@@ -27,8 +31,12 @@
2731
"oracle_deprecated",
2832
"dbapi_extension",
2933
"sphinx_rtd_theme",
34+
"sphinx.ext.autodoc",
3035
]
3136

37+
# preserve defaults in function signatures
38+
autodoc_preserve_defaults = True
39+
3240
# Add any paths that contain templates here, relative to this directory.
3341
templates_path = [".templates"]
3442

doc/src/release_notes.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Thick Mode Changes
2323
Common Changes
2424
++++++++++++++
2525

26+
#) API documentation is now generated from the source code.
27+
2628

2729
oracledb `3.3.0 <https://github.com/oracle/python-oracledb/compare/v3.2.0...v3.3.0>`__ (July 2025)
2830
--------------------------------------------------------------------------------------------------

0 commit comments

Comments
 (0)