Skip to content

Commit 8626243

Browse files
sharadrajusharadraju
committed
Documentation update for 6.0
1 parent c6d26da commit 8626243

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+8754
-6601
lines changed

Diff for: ‎INSTALL.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installing node-oracledb Version 6.0.0-dev
1+
# Installing node-oracledb
22

33
*Copyright (c) 2015, 2023, Oracle and/or its affiliates.*
44

@@ -21,21 +21,19 @@ under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
2121
CONDITIONS OF ANY KIND, either express or implied. See the License for the
2222
specific language governing permissions and limitations under the License.
2323

24-
## Note: The node-oracledb 5.5 installation instructions have moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html).
25-
26-
## The new documentation layout facilitates better search and navigation of the content. For future node-oracledb releases, the latest updates will only be added to the new node-oracledb documentation.
24+
## Note: The node-oracledb installation instructions have moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html).
2725

2826
## <a name="overview"></a> 1. Node-oracledb Overview
2927

30-
The documentation has moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#overview](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#overview).
28+
[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#overview)
3129

3230
## <a name="quickstart"></a> 2. Quick Start node-oracledb Installation
3331

34-
The documentation has moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart).
32+
[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#quickstart)
3533

3634
## <a name="instructions"></a> 3. Node-oracledb Installation Instructions
3735

38-
The documentation has moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instructions](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instructions).
36+
[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#instructions)
3937

4038
### <a name="prerequisites"></a> 3.1 Prerequisites
4139

@@ -131,8 +129,8 @@ The documentation has moved to [https://node-oracledb.readthedocs.io/en/latest/u
131129

132130
## <a name="installingoldvers"></a> <a name="installingv2"></a> <a name="installingv1"></a> 4. Installing Older Versions of Node-oracledb
133131

134-
The documentation has moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#installingoldvers](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#installingoldvers).
132+
[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#installingoldvers)
135133

136134
## <a name="troubleshooting"></a> 5. Troubleshooting Node-oracledb Installation Problems
137135

138-
The documentation has moved to [https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting).
136+
[View latest documentation](https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html#troubleshooting)

Diff for: ‎doc/api.md

+43-44
Large diffs are not rendered by default.

Diff for: ‎doc/images/node-oracledb-architecture.png

-53 KB
Binary file not shown.

Diff for: ‎doc/requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
sphinx>=4.2.0
2-
sphinx-rtd-theme
2+
sphinx-rtd-theme>=0.5.2

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

+23-2
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,35 @@
99
font-size: 11pt;
1010
}
1111

12-
/*Added code to remove the line spacing between bullets in a list */
12+
/*Added code to remove the line spacing between bullet lists in a table */
1313
.wy-table-responsive table td ul{
1414
line-height: 0pt;
1515
margin-bottom: 0pt;
1616
}
1717

18-
/* Added code to remove the extra white line displayed at the bottom of the code-block */
18+
/* Added code to remove the extra white line displayed at the bottom of the code-block in a table */
1919
.wy-table-responsive table td div{
2020
line-height: 0pt;
2121
margin-bottom: 0pt;
2222
}
23+
24+
/* Added code to wrap the code-blocks that are used in a table*/
25+
.wy-table-responsive table td pre{
26+
white-space: pre-wrap !important;
27+
}
28+
29+
/* Added code to add white space between the figure and the figure caption */
30+
figcaption{
31+
margin-top: 10pt;
32+
}
33+
34+
/* Added code to add white space between the bullet point and text after bullet */
35+
li p{
36+
padding-left: 5pt;
37+
}
38+
39+
/* Added code to make the deprecated, versionadded, versionmodified, and desupported directives bold and font smaller */
40+
.versionmodified{
41+
font-size: 11pt;
42+
font-weight: bold;
43+
}

Diff for: ‎doc/src/_ext/oracle_deprecated.py renamed to ‎doc/src/_ext/oracle_desupported.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#------------------------------------------------------------------------------
2-
# Copyright (c) 2022, Oracle and/or its affiliates.
2+
# Copyright (c) 2023, Oracle and/or its affiliates.
33
#
44
# This software is dual-licensed to you under the Universal Permissive License
55
# (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
@@ -23,18 +23,18 @@
2323
#------------------------------------------------------------------------------
2424

2525
#------------------------------------------------------------------------------
26-
# oracle_deprecated.py
26+
# oracle_desupported.py
2727
#
28-
# Overrides the 'deprecated' directive so that it can a componment name can be
29-
# used in conjunction with the version.
28+
# Defines a directive (desupported) which describes when the feature was
29+
# removed. Similar to the deprecated directive.
3030
#------------------------------------------------------------------------------
3131

3232

3333
from docutils import nodes
3434
from docutils.parsers.rst import Directive
3535
from sphinx import addnodes
3636

37-
class DriverDeprecated(Directive):
37+
class DriverDesupported(Directive):
3838
has_content = True
3939
required_arguments = 1
4040
optional_arguments = 0
@@ -45,7 +45,7 @@ def run(self):
4545
node.document = self.state.document
4646
node['type'] = self.name
4747
node['version'] = self.arguments[0]
48-
text = 'Deprecated since {}.'.format(self.arguments[0])
48+
text = 'Desupported in version {}.'.format(self.arguments[0])
4949
classes = ['versionmodified', 'deprecated']
5050
para = nodes.paragraph('', '',
5151
nodes.inline('', text, classes=classes),
@@ -55,7 +55,7 @@ def run(self):
5555
return ret
5656

5757
def setup(app):
58-
app.add_directive("deprecated", DriverDeprecated, override=True)
58+
app.add_directive("desupported", DriverDesupported, override=True)
5959

6060
return {
6161
'version': '0.1',

Diff for: ‎doc/src/api_manual/aq.rst

+5
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ An AqQueue object is created by
99
dequeuing Oracle Advanced Queuing messages. Each AqQueue can be used for
1010
enqueuing, dequeuing, or for both.
1111

12+
.. note::
13+
14+
In this release, Oracle Advanced Queuing (AQ) is only supported in the
15+
node-oracledb Thick mode. See :ref:`enablingthick`.
16+
1217
See :ref:`Oracle Advanced Queuing (AQ) <aq>` for usage.
1318

1419
The AqQueue class was added in node-oracledb 4.0.

0 commit comments

Comments
 (0)