From 7e3c61d184928a84d93f01e1ca3180dff9eb68fd Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Thu, 8 Jan 2026 18:02:09 +0700 Subject: [PATCH 01/10] feat: improve document api reference --- docs/api_reference.md | 6 ++++++ docs/mkdocs.yml | 12 ++++++++++++ docs/requirements.txt | 2 ++ 3 files changed, 20 insertions(+) create mode 100644 docs/api_reference.md diff --git a/docs/api_reference.md b/docs/api_reference.md new file mode 100644 index 0000000..1351e1b --- /dev/null +++ b/docs/api_reference.md @@ -0,0 +1,6 @@ +# API Reference + +::: exceptions +::: query +::: write_client +::: read_file \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c38c9cc..e3105ea 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -2,5 +2,17 @@ site_name: InfluxDB 3.0 Python Client docs_dir: . nav: - Home: index.md + - API Reference: api_reference.md plugins: - include-markdown + - mkdocstrings: + handlers: + python: + paths: [ ../influxdb_client_3 ] + options: + summary: true + show_source: true + show_root_heading: true + members_order: alphabetical + show_submodules: true + members: true \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index a6f80a9..9c46359 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,4 @@ mkdocs mkdocs-include-markdown-plugin +mkdocstrings +mkdocstrings-python \ No newline at end of file From 92e23ba0037f52fe696d34b2c3f1c133f1956635 Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Thu, 8 Jan 2026 18:06:01 +0700 Subject: [PATCH 02/10] refactor: remove old documentation link --- influxdb_client_3/write_client/client/write_api.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/influxdb_client_3/write_client/client/write_api.py b/influxdb_client_3/write_client/client/write_api.py index 83e0dcd..aa57830 100644 --- a/influxdb_client_3/write_client/client/write_api.py +++ b/influxdb_client_3/write_client/client/write_api.py @@ -296,9 +296,7 @@ def __init__(self, if self._write_options.write_type is WriteType.asynchronous: message = """The 'WriteType.asynchronous' is deprecated and will be removed in future major version. - -You can use native asynchronous version of the client: -- https://influxdb-client.readthedocs.io/en/stable/usage.html#how-to-use-asyncio + You can use native asynchronous version of the client: """ # TODO above message has link to Influxdb2 API __NOT__ Influxdb3 API !!! - illustrates different API warnings.warn(message, DeprecationWarning) From b37f2ae05a47c06718a36ebaebbb6a43d23f7e49 Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Thu, 8 Jan 2026 18:37:36 +0700 Subject: [PATCH 03/10] chore: CHANGELOG.md --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e86575..ebea945 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,10 @@ 1. [#180](https://github.com/InfluxCommunity/influxdb3-python/pull/180): Add `flush()` method to `InfluxDBClient3`: - Allows flushing the write buffer without closing the client when using batching mode. - Enables applications to ensure data is written before querying, while keeping the client open for further operations. +1. [#185](https://github.com/InfluxCommunity/influxdb3-python/pull/185): + - Add API Reference page on document page + - Remove old document link. + - Add link to document page to README.md ### Bug Fixes From 714d88b36336b1249309bed2796b8623f26e1749 Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Thu, 8 Jan 2026 18:43:08 +0700 Subject: [PATCH 04/10] [EMPTY] trigger CI From 61ada5f6a14a5a6579a641cbf20ac563bd08c4b2 Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Thu, 8 Jan 2026 18:48:03 +0700 Subject: [PATCH 05/10] chore: add document link to README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 13de5af..64d66d1 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,11 @@ `influxdb_client_3` is a Python module that provides a simple and convenient way to interact with InfluxDB 3.0. This module supports both writing data to InfluxDB and querying data using the Flight client, which allows you to execute SQL and InfluxQL queries on InfluxDB 3.0. +## Documentation + +This is full document link +- [Getting Started](https://influxdb3-python.readthedocs.io/en/latest/) + We offer a ["Getting Started: InfluxDB 3.0 Python Client Library"](https://www.youtube.com/watch?v=tpdONTm1GC8) video that goes over how to use the library and goes over the examples. ## Dependencies From 6cc79196133c0cd305c18278da47ce0ef7ee5a4b Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Thu, 8 Jan 2026 18:52:01 +0700 Subject: [PATCH 06/10] chore: CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ebea945..8c23338 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,7 +18,7 @@ 1. [#185](https://github.com/InfluxCommunity/influxdb3-python/pull/185): - Add API Reference page on document page - Remove old document link. - - Add link to document page to README.md + - Add link to document page in README.md ### Bug Fixes From 1f7a067dedd52e077aabe4bc2eb0917730659df2 Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Fri, 9 Jan 2026 15:05:57 +0700 Subject: [PATCH 07/10] feat: improve document api reference --- docs/api_reference.md | 17 +++++++++++++---- docs/mkdocs.yml | 7 ++----- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/api_reference.md b/docs/api_reference.md index 1351e1b..a4a0aa9 100644 --- a/docs/api_reference.md +++ b/docs/api_reference.md @@ -1,6 +1,15 @@ # API Reference -::: exceptions -::: query -::: write_client -::: read_file \ No newline at end of file +::: __init__.InfluxDBClient3 + options: + members: + - from_env + - write + - write_file + - write_dataframe + - query + - query_dataframe + - query_async + - get_server_version + - flush + - close \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index e3105ea..7f4d02c 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -11,8 +11,5 @@ plugins: paths: [ ../influxdb_client_3 ] options: summary: true - show_source: true - show_root_heading: true - members_order: alphabetical - show_submodules: true - members: true \ No newline at end of file + show_symbol_type_toc: true + show_symbol_type_heading: true \ No newline at end of file From 70bb1eeaaa0a94ffbb68d8187c598b35b08d583b Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Mon, 12 Jan 2026 10:25:37 +0700 Subject: [PATCH 08/10] chore: add ReadTheDocs badge to README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 64d66d1..d04f251 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@

+ + PyPI version + PyPI version From aa5f946f950ea99c85fd091ee2f9eeb7d94d323d Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Mon, 12 Jan 2026 10:29:18 +0700 Subject: [PATCH 09/10] chore: update ReadTheDocs badge alt text in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d04f251..5ab06f5 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

- PyPI version + Readthedocs document PyPI version From 3f1a8d5ae0ef1913cf46769bc871e3ee4c0dcb6c Mon Sep 17 00:00:00 2001 From: NguyenHoangSon96 Date: Mon, 12 Jan 2026 13:07:48 +0700 Subject: [PATCH 10/10] chore: remove duplicate documentation link from README.md --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 5ab06f5..0be7419 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,6 @@ `influxdb_client_3` is a Python module that provides a simple and convenient way to interact with InfluxDB 3.0. This module supports both writing data to InfluxDB and querying data using the Flight client, which allows you to execute SQL and InfluxQL queries on InfluxDB 3.0. -## Documentation - -This is full document link -- [Getting Started](https://influxdb3-python.readthedocs.io/en/latest/) - We offer a ["Getting Started: InfluxDB 3.0 Python Client Library"](https://www.youtube.com/watch?v=tpdONTm1GC8) video that goes over how to use the library and goes over the examples. ## Dependencies