feat: improve document api reference (#185)

NguyenHoangSon96 · web-flow · commit 37cf75a42e53 · 2026-01-12T10:41:52.000+01:00
* feat: improve document api reference

* refactor: remove old documentation link

* chore: CHANGELOG.md

* [EMPTY] trigger CI

* chore: add document link to README.md

* chore: CHANGELOG.md

* feat: improve document api reference

* chore: add ReadTheDocs badge to README.md

* chore: update ReadTheDocs badge alt text in README.md

* chore: remove duplicate documentation link from README.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,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 in README.md
 
 ### Bug Fixes
 
diff --git a/README.md b/README.md
@@ -4,6 +4,9 @@
 </p>
 
 <p align="center">
+    <a href="https://influxdb3-python.readthedocs.io/en/latest/">
+        <img src="https://img.shields.io/readthedocs/influxdb3-python/latest" alt="Readthedocs document">
+    </a>
     <a href="https://pypi.org/project/influxdb3-python/">
         <img src="https://img.shields.io/pypi/v/influxdb3-python.svg" alt="PyPI version">
     </a>
diff --git a/docs/api_reference.md b/docs/api_reference.md
@@ -0,0 +1,15 @@
+# API Reference
+
+::: __init__.InfluxDBClient3
+    options:
+        members:
+            - from_env
+            - write
+            - write_file
+            - write_dataframe
+            - query
+            - query_dataframe
+            - query_async
+            - get_server_version
+            - flush
+            - close
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -2,5 +2,14 @@ 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_symbol_type_toc: true
+            show_symbol_type_heading: true
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,4 @@
 mkdocs
 mkdocs-include-markdown-plugin
+mkdocstrings
+mkdocstrings-python
diff --git 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)
