diff --git a/CHANGELOG.md b/CHANGELOG.md index 3e86575..8c23338 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 in README.md ### Bug Fixes diff --git a/README.md b/README.md index 13de5af..0be7419 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@
+
+
+
diff --git a/docs/api_reference.md b/docs/api_reference.md
new file mode 100644
index 0000000..a4a0aa9
--- /dev/null
+++ 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
\ No newline at end of file
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index c38c9cc..7f4d02c 100644
--- 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
\ 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
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)