GG-32405: Fix documentation links (#25)

Author: isapego

docs/conf.py

@@ -20,8 +20,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'GridGain binary client Python API'
-copyright = '2018-2019, GridGain Community Edition License'
-author = 'Dmitry Melnichuk'
+copyright = '2018-2021, GridGain Community Edition License'
+author = 'GridGain Systems, Inc.'
 
 # The short X.Y version
 version = ''

docs/datatypes/parsers.rst

@@ -47,8 +47,8 @@ of interoperability, you may have to sneak one or the other class, along
 with your data, in to some API function as a *type conversion hint*.
 
 +-----------+--------------------+-------------------------------+------------------------------------------------------------------+
-|`type_code`|GridGain            |Python type                    |Parser/constructor                                                |
-|           |docs reference      |or class                       |class                                                             |
+|`type_code`|Documentation       |Python type                    |Parser/constructor                                                |
+|           |reference           |or class                       |class                                                             |
 +===========+====================+===============================+==================================================================+
 |*Primitive data types*                                                                                                             |
 +-----------+--------------------+-------------------------------+------------------------------------------------------------------+
@@ -135,40 +135,40 @@ with your data, in to some API function as a *type conversion hint*.
 |0x1b       |`Wrapped data`_     |tuple[int, bytes]              |:class:`~pygridgain.datatypes.complex.WrappedDataObject`          |
 +-----------+--------------------+-------------------------------+------------------------------------------------------------------+
 
-.. _Byte: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-byte
-.. _Short: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-short
-.. _Int: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-int
-.. _Long: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-long
-.. _Float: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-float
-.. _Double: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-double
-.. _Char: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-char
-.. _Bool: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-bool
-.. _Null: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-null
-.. _String: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-string
-.. _UUID: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-uuid-guid-
-.. _Timestamp: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-timestamp
-.. _Date: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-date
-.. _Time: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-time
-.. _Decimal: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-decimal
-.. _Enum: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-enum
-.. _Byte array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-byte-array
-.. _Short array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-short-array
-.. _Int array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-int-array
-.. _Long array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-long-array
-.. _Float array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-float-array
-.. _Double array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-double-array
-.. _Char array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-char-array
-.. _Bool array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-bool-array
-.. _String array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-string-array
-.. _UUID array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-uuid-guid-array
-.. _Timestamp array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-timestamp-array
-.. _Date array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-date-array
-.. _Time array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-time-array
-.. _Decimal array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-decimal-array
-.. _Object array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-object-collections
-.. _Collection: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-collection
-.. _Map: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-map
-.. _Enum array: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-enum-array
-.. _Binary enum: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-binary-enum
-.. _Wrapped data: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-wrapped-data
-.. _Complex object: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-complex-object
+.. _Byte: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#byte
+.. _Short: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#short
+.. _Int: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#int
+.. _Long: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#long
+.. _Float: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#float
+.. _Double: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#double
+.. _Char: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#char
+.. _Bool: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#bool
+.. _Null: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#null
+.. _String: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#string
+.. _UUID: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#uuid-guid
+.. _Timestamp: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#timestamp
+.. _Date: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#date
+.. _Time: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#time
+.. _Decimal: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#decimal
+.. _Enum: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#enum
+.. _Byte array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#byte-array
+.. _Short array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#short-array
+.. _Int array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#int-array
+.. _Long array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#long-array
+.. _Float array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#float-array
+.. _Double array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#double-array
+.. _Char array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#char-array
+.. _Bool array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#bool-array
+.. _String array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#string-array
+.. _UUID array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#uuid-guid-array
+.. _Timestamp array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#timestamp-array
+.. _Date array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#date-array
+.. _Time array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#time-array
+.. _Decimal array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#decimal-array
+.. _Object array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#object-collections
+.. _Collection: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#collection
+.. _Map: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#map
+.. _Enum array: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#enum-array
+.. _Binary enum: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#binary-enum
+.. _Wrapped data: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#wrapped-data
+.. _Complex object: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#complex-object

docs/examples.rst

@@ -649,24 +649,24 @@ with the following message:
 
     # pygridgain.exceptions.HandshakeError: Handshake error: Unauthenticated sessions are prohibited.
 
-.. _get_and_put.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/get_and_put.py
-.. _type_hints.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/type_hints.py
-.. _failover.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/failover.py
-.. _scans.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/scans.py
-.. _sql.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/sql.py
-.. _binary_basics.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/binary_basics.py
-.. _read_binary.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/read_binary.py
-.. _create_binary.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/create_binary.py
-.. _migrate_binary.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/migrate_binary.py
-.. _Getting Started: https://apacheignite-sql.readme.io/docs/getting-started
+.. _get_and_put.py: https://github.com/gridgain/python-thin-client/tree/master/examples/get_and_put.py
+.. _type_hints.py: https://github.com/gridgain/python-thin-client/tree/master/examples/type_hints.py
+.. _failover.py: https://github.com/gridgain/python-thin-client/tree/master/examples/failover.py
+.. _scans.py: https://github.com/gridgain/python-thin-client/tree/master/examples/scans.py
+.. _sql.py: https://github.com/gridgain/python-thin-client/tree/master/examples/sql.py
+.. _binary_basics.py: https://github.com/gridgain/python-thin-client/tree/master/examples/binary_basics.py
+.. _read_binary.py: https://github.com/gridgain/python-thin-client/tree/master/examples/read_binary.py
+.. _create_binary.py: https://github.com/gridgain/python-thin-client/tree/master/examples/create_binary.py
+.. _migrate_binary.py: https://github.com/gridgain/python-thin-client/tree/master/examples/migrate_binary.py
+.. _Getting Started: https://ignite.apache.org/docs/latest/quick-start/sql
 .. _GridGain CE GitHub repository: https://github.com/gridgain/gridgain/blob/master/examples/sql/world.sql
-.. _Complex object: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-complex-object
+.. _Complex object: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#complex-object
 .. _Java keytool: https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html
-.. _Securing Connection Between Nodes: https://apacheignite.readme.io/docs/ssltls#section-securing-connection-between-nodes
-.. _ClientConnectorConfiguration: https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/configuration/ClientConnectorConfiguration.html
+.. _Securing Connection Between Nodes: https://ignite.apache.org/docs/latest/security/ssl-tls#ssltls-for-nodes
+.. _ClientConnectorConfiguration: https://www.gridgain.com/sdk/latest/javadoc/org/apache/ignite/configuration/ClientConnectorConfiguration.html
 .. _openssl: https://www.openssl.org/docs/manmaster/man1/openssl.html
-.. _Authentication: https://apacheignite.readme.io/docs/advanced-security#section-authentication
+.. _Authentication: https://ignite.apache.org/docs/latest/security/authentication
 .. _attrs: https://pypi.org/project/attrs/
-.. _get_and_put_complex.py: https://github.com/gridgain/gridgain/tree/master/modules/platforms/python/examples/get_and_put_complex.py
-.. _Collection: https://apacheignite.readme.io/docs/binary-client-protocol-data-format#section-collection
-.. _simple class names: https://apacheignite.readme.io/docs/binary-marshaller#binary-name-mapper-and-binary-id-mapper
+.. _get_and_put_complex.py: https://github.com/gridgain/python-thin-client/tree/master/examples/get_and_put_complex.py
+.. _Collection: https://ignite.apache.org/docs/latest/binary-client-protocol/data-format#collection
+.. _simple class names: https://ignite.apache.org/docs/latest/data-modeling/binary-marshaller#binary-name-mapper-and-binary-id-mapper

docs/readme.rst

@@ -60,7 +60,7 @@ the whole repository:
 ::
 
 $ git clone git@github.com:gridgain/gridgain.git
-$ cd gridgain/modules/platforms/python
+$ cd python-thin-client
 $ pip install -e .
 
 This will install the repository version of `pygridgain` into your environment
@@ -80,7 +80,7 @@ Examples
 --------
 
 Some examples of using pygridgain are provided in
-`gridgain/modules/platforms/python/examples` folder. They are extensively
+`python-thin-client/examples` folder. They are extensively
 commented in the :ref:`examples_of_usage` section of the documentation.
 
 This code implies that it is run in the environment with `pygridgain` package
@@ -97,7 +97,7 @@ Create and activate virtualenv_ environment. Run
 
 ::
 
-$ cd gridgain/modules/platforms/python
+$ cd python-thin-client
 $ python ./setup.py pytest
 
 This does not require `pytest` and other test dependencies to be installed
@@ -172,14 +172,14 @@ To recompile this documentation, do this from your virtualenv_ environment:
 
 ::
 
-$ cd gridgain/modules/platforms/python
+$ cd python-thin-client
 $ pip install -r requirements/docs.txt
 $ cd docs
 $ make clean
 $ sphinx-apidoc -feM -o source/ ../ ../setup.py
 $ make html
 
-Then open `gridgain/modules/platforms/python/docs/generated/html/index.html`_
+Then open `python-thin-client/docs/generated/html/index.html`_
 in your browser.
 
 Licensing
@@ -189,9 +189,9 @@ This is a free software, brought to you on terms of the
 `GridGain Community Edition License`_.
 
 .. _GridGain: https://docs.gridgain.com/docs
-.. _binary client protocol: https://apacheignite.readme.io/docs/binary-client-protocol
+.. _binary client protocol: https://ignite.apache.org/docs/latest/binary-client-protocol/binary-client-protocol
 .. _GridGain Community Edition License: https://www.gridgain.com/products/software/community-edition/gridgain-community-edition-license
 .. _virtualenv: https://virtualenv.pypa.io/
 .. _setuptools: https://setuptools.readthedocs.io/
-.. _gridgain/modules/platforms/python/docs/generated/html/index.html: .
+.. _python-thin-client/docs/generated/html/index.html: .
 .. _editable installs: https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs