Skip to content

Commit

Permalink
CON-305: Update documentation (#194)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alxe authored and alexcamposruiz committed Mar 8, 2024
1 parent 45d1b64 commit 5df69b2
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 25 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ The dependency [ref](https://www.npmjs.com/package/ref) is shipped as source cod

## License

RTI Connector for JavaScript and RTI Connector for Python are part of the Connext
DDS Professional Package. If you have a valid license for the RTI Connext DDS
Professional Package, such license shall govern your use of RTI Connector for
Python and RTI Connector for JavaScript. All other use of this software shall
RTI Connector for JavaScript is part of the Connext
Professional Package. If you have a valid license for the RTI Connext
Professional Package, such license shall govern your use of
RTI Connector for JavaScript. All other use of this software shall
be governed solely by the terms of RTI’s Software License for Non-Commercial
Use #4040, included at the top level of the `Connector for Python repository
Use #4040.
11 changes: 5 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,9 @@ source code and requires a C++11 compiler.
License
-------

RTI Connector for JavaScript and RTI Connector for Python are part of
the Connext DDS Professional Package. If you have a valid license for
the RTI Connext DDS Professional Package, such license shall govern your
use of RTI Connector for Python and RTI Connector for JavaScript. All
RTI Connector for JavaScript is part of
the Connext Professional Package. If you have a valid license for
the RTI Connext Professional Package, such license shall govern your
use of RTI Connector for JavaScript. All
other use of this software shall be governed solely by the terms of
RTI’s Software License for Non-Commercial Use #4040, included at the top
level of the \`Connector for Python repository
RTI’s Software License for Non-Commercial Use #4040.
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# -- Project information -----------------------------------------------------

project = 'RTI Connector for JavaScript'
copyright = '2022, Real-Time Innovations, Inc.'
copyright = '2024, Real-Time Innovations, Inc.'
author = 'Real-Time Innovations, Inc.'

# The full version, including alpha/beta/rc tags
Expand Down Expand Up @@ -145,7 +145,7 @@ def setup(app):
master_doc,
'rticonnectorforjavascript.tex',
'RTI Connector for Javascript',
'2022, Real-Time Innovations, Inc.',
'2024, Real-Time Innovations, Inc.',
'manual'
),
]
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ how they are exposed in the *Connector* API:

.. hint::

For an example configuration file, see `ShapeExample.xml <https://github.com/rticommunity/rticonnextdds-connector-py/blob/master/examples/python/ShapeExample.xml>`__.
For an example configuration file, see `ShapeExample.xml <https://github.com/rticommunity/rticonnextdds-connector-js/blob/master/examples/nodejs/ShapeExample.xml>`__.

Data types
~~~~~~~~~~
Expand Down
16 changes: 9 additions & 7 deletions docs/copyright_license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
Copyrights and License
**********************

© 2022 Real-Time Innovations, Inc. |br|
© 2024 Real-Time Innovations, Inc. |br|
All rights reserved. |br|
Printed in U.S.A. First printing. |br|
February 2022. |br|
March 2024. |br|

.. rubric:: License

RTI Connector for JavaScript and RTI Connector for Python are part of the Connext
DDS Professional Package. If you have a valid license for the RTI Connext DDS
Professional Package, such license shall govern your use of RTI Connector for
Python and RTI Connector for JavaScript. All other use of this software shall
RTI Connector for JavaScript is part of the Connext
Professional Package. If you have a valid license for the RTI Connext
Professional Package, such license shall govern your use of
RTI Connector for JavaScript. All other use of this software shall
be governed solely by the terms of RTI’s Software License for Non-Commercial
Use #4040, included at the top level of the `Connector for JavaScript repository
<https://github.com/rticommunity/rticonnextdds-connector-js>`__.
Expand Down Expand Up @@ -90,9 +90,11 @@ Website: https://support.rti.com/ |br|
* The source code of this software (from https://github.com/udp/json-parser)
is used to build the native libraries provided by *RTI Connector*.

* Version 1.1.0

* License:

Copyright (C) 2012, 2013, 2014 James McLaughlin et al. All rights reserved.
Copyright (C) 2012-2021 the json-parser authors All rights reserved.
https://github.com/udp/json-parser

Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ data distribution efficient and robust. At its core is the world's
leading ultra-high performance, distributed networking databus.

*RTI Connector* is a family of simplified APIs for publishing and subscribing
to the *Connext DDS* Databus in programming languages such as Python and JavaScript.
to the *Connext* Databus in programming languages such as JavaScript.

.. note::

Expand Down
5 changes: 2 additions & 3 deletions docs/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,14 @@ macOS® platforms. It has been tested on the following systems:
**Linux**
* CentOS™ 7.0 (x64)
* Red Hat® Enterprise Linux 7, 7.3, 7.5, 7.6, 8, 9 (x64)
* Ubuntu® 18.04 (x64, Arm v7, Arm v8)
* Ubuntu 20.04 (x64), 22.04 (x64, Arm v8)
* Ubuntu® 18.04 LTS (x64, Arm v7, Arm v8), 20.04 LTS (x64), 22.04 LTS (x64, Arm v8)

**macOS**
* macOS 11, 12, 13 (x64)

**Windows**
* Windows 10, 11 (x64)
* Windows Server 2016 (x64)
* Windows Server 2016, 2022 (x64)

*Connector* is supported in other languages in addition to JavaScript, see
`the main Connector
Expand Down

0 comments on commit 5df69b2

Please sign in to comment.