Skip to content

Commit 53b041a

Browse files
Correct tables in documentation.
1 parent 1eb26ac commit 53b041a

File tree

10 files changed

+26
-12
lines changed

10 files changed

+26
-12
lines changed

Diff for: doc/src/.static/custom.css

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/* Added code to display tables without horizontal scrollbars */
2+
.wy-table-responsive table td, .wy-table-responsive table th {
3+
white-space: normal;
4+
}

Diff for: doc/src/api_manual/cursor.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -385,8 +385,10 @@ Cursor Methods
385385
types:
386386

387387
.. list-table-with-summary::
388-
:summary: The first column is the Python Type. The second column is the corresponding Database Type.
389388
:header-rows: 1
389+
:class: wy-table-responsive
390+
:align: center
391+
:summary: The first column is the Python Type. The second column is the corresponding Database Type.
390392

391393
* - Python Type
392394
- Database Type

Diff for: doc/src/api_manual/deprecations.rst

+5-10
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ if applicable. The most recent deprecations are listed first.
1111

1212
.. list-table-with-summary:: Deprecated in python-oracledb 1.0
1313
:header-rows: 1
14-
:widths: 25 75
15-
:width: 100%
14+
:class: wy-table-responsive
1615
:summary: The first column, Name, displays the deprecated API name. The second column, Comments, includes information about when the API was deprecated and what API to use, if applicable.
1716
:name: _deprecations_1
1817

@@ -110,8 +109,7 @@ python-oracledb are listed below:
110109

111110
.. list-table-with-summary:: Deprecated in cx_Oracle 8.2
112111
:header-rows: 1
113-
:widths: 25 75
114-
:width: 100%
112+
:class: wy-table-responsive
115113
:summary: The first column, Name, displays the deprecated API name. The second column,
116114
Comments, includes information about when the API was deprecated and what API to use,
117115
if applicable.
@@ -209,8 +207,7 @@ python-oracledb are listed below:
209207

210208
.. list-table-with-summary:: Deprecated in cx_Oracle 8.0
211209
:header-rows: 1
212-
:widths: 25 75
213-
:width: 100%
210+
:class: wy-table-responsive
214211
:summary: The first column, Name, displays the deprecated API name. The second column, Comments, includes information about when the API was deprecated and what API to use, if applicable.
215212
:name: _deprecations_8_0
216213

@@ -252,8 +249,7 @@ python-oracledb are listed below:
252249

253250
.. list-table-with-summary:: Deprecated in cx_Oracle 7.2
254251
:header-rows: 1
255-
:widths: 25 75
256-
:width: 100%
252+
:class: wy-table-responsive
257253
:summary: The first column, Name, displays the deprecated API name. The second column, Comments, includes information about when the API was deprecated and what API to use, if applicable.
258254
:name: _deprecations_7_2
259255

@@ -271,8 +267,7 @@ python-oracledb are listed below:
271267

272268
.. list-table-with-summary:: Deprecated in cx_Oracle 6.4
273269
:header-rows: 1
274-
:widths: 25 75
275-
:width: 100%
270+
:class: wy-table-responsive
276271
:summary: The first column, Name, displays the deprecated API name. The second column, Comments, includes information about when the API was deprecated and what API to use, if applicable.
277272
:name: _deprecations_6_4
278273

Diff for: doc/src/conf.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
# Add any paths that contain custom static files (such as style sheets) here,
9090
# relative to this directory. They are copied after the builtin static files,
9191
# so a file named "default.css" will overwrite the builtin "default.css".
92-
#html_static_path = ['.static']
92+
html_static_path = ['.static']
9393

9494
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
9595
# using the given strftime format.
@@ -120,6 +120,10 @@
120120

121121
numfig = True
122122

123+
# Display tables with no horizontal scrollbar
124+
def setup(app):
125+
app.add_css_file('custom.css')
126+
123127
# Options for LaTeX output
124128
# ------------------------
125129

Diff for: doc/src/user_guide/appendix_a.rst

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ see :ref:`driverdiff` and :ref:`compatibility`.
1818

1919
.. list-table-with-summary:: Features Supported by python-oracledb and cx_Oracle 8.3
2020
:header-rows: 1
21+
:class: wy-table-responsive
2122
:align: center
2223
:summary: The first column displays the Oracle feature. The second column indicates whether the feature is supported in the python-oracledb Thin mode. The third column indicates whether the feature is supported in the python-oracledb Thick mode. The fourth column indicates if the feature is supported in cx_Oracle 8.3.
2324

@@ -387,6 +388,7 @@ values.
387388

388389
.. list-table-with-summary:: Oracle Database Data Types Supported
389390
:header-rows: 1
391+
:class: wy-table-responsive
390392
:align: center
391393
:summary: The first column displays the database data type. The second column displays the python-oracledb constant Name. The third column indicates if the type is supported in python-oracledb.
392394

Diff for: doc/src/user_guide/appendix_b.rst

+1
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ used in :meth:`oracledb.connect()`, :meth:`oracledb.create_pool()`,
9191

9292
.. list-table-with-summary:: Oracle Net Keywords Supported in the python-oracledb Thin Mode
9393
:header-rows: 1
94+
:class: wy-table-responsive
9495
:align: center
9596
:summary: The first column displays the keyword. The second column displays the equivalent oracledb.connect(), oracledb.create_pool(), oracledb.ConnectParams(), or oracledb.PoolParams() parameters. The third column displays the notes.
9697

Diff for: doc/src/user_guide/initialization.rst

+1
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,7 @@ first connection is established. System environment variables like
429429

430430
.. list-table-with-summary:: Common Oracle environment variables
431431
:header-rows: 1
432+
:class: wy-table-responsive
432433
:widths: 1 2
433434
:summary: The first column displays the Oracle Environment Variable. The second column, Purpose, describes what the environment variableis used for.
434435
:align: left

Diff for: doc/src/user_guide/json_data_type.rst

+2
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ needed but there is no direct mapping from Python.
173173

174174
.. list-table-with-summary::
175175
:header-rows: 1
176+
:class: wy-table-responsive
176177
:widths: 1 1 1
177178
:summary: The first column is the Python Type or Value. The second column is the equivalent JSON Attribute Type or Value. The third column is the SQL Equivalent syntax.
178179
:align: left
@@ -263,6 +264,7 @@ attribute mapping occurs:
263264

264265
.. list-table-with-summary::
265266
:header-rows: 1
267+
:class: wy-table-responsive
266268
:widths: 1 1
267269
:align: left
268270
:summary: The first column is the Database JSON Attribute Type or Value. The second column is the corresponding Python Type or Value mapped.

Diff for: doc/src/user_guide/sql_execution.rst

+1
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ Python object that is returned by default. Python types can be changed with
164164

165165
.. list-table-with-summary::
166166
:header-rows: 1
167+
:class: wy-table-responsive
167168
:widths: 1 1 1
168169
:align: left
169170
:summary: The first column is the Oracle Database Type. The second column is the oracledb Database Type that is returned in the query metadata. The third column is the type of Python object that is returned by default.

Diff for: doc/src/user_guide/tracing.rst

+2
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,7 @@ columns:
287287

288288
.. list-table-with-summary:: Sample V$SESSION_CONNECT_INFO column values
289289
:header-rows: 1
290+
:class: wy-table-responsive
290291
:widths: 15 10 10
291292
:name: V$SESSION_CONNECT_INFO
292293
:summary: The first column is the name of V$SESSION_CONNECT_INFO view's column. The second column lists a sample python-oracledb Thick mode value. The third column list a sample python-oracledb Thin mode value.
@@ -314,6 +315,7 @@ The following table list sample values for columns with differences in
314315

315316
.. list-table-with-summary:: Sample V$SESSION column values
316317
:header-rows: 1
318+
:class: wy-table-responsive
317319
:widths: 15 10 10
318320
:name: V$SESSION_COLUMN_VALUES
319321
:summary: The first column is the name of the column. The second column lists a sample python-oracledb Thick mode value. The third column lists a sample python-oracledb Thin mode value.

0 commit comments

Comments
 (0)