From cefe19b748ccd1cff5703367075b9b4e25586605 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 6 Aug 2024 10:27:04 +0200 Subject: [PATCH] [Backport 8.15] Fix reference docs (#2629) (cherry picked from commit d4eb86ead92e1a7dfb58bec37cef07dce1fb5c5e) Co-authored-by: Quentin Pradet --- docs/sphinx/api.rst | 1 + docs/sphinx/api/async-search.rst | 10 ++++++++++ docs/sphinx/api/autoscaling.rst | 2 +- docs/sphinx/api/cat.rst | 2 +- docs/sphinx/api/ccr.rst | 2 +- docs/sphinx/api/cluster.rst | 2 +- docs/sphinx/api/connector.rst | 2 +- docs/sphinx/api/dangling-indices.rst | 2 +- docs/sphinx/api/elasticsearch.rst | 4 +--- docs/sphinx/api/enrich-policies.rst | 2 +- docs/sphinx/api/eql.rst | 2 +- docs/sphinx/api/esql.rst | 2 +- docs/sphinx/api/fleet.rst | 2 +- docs/sphinx/api/graph-explore.rst | 2 +- docs/sphinx/api/index-lifecycle-management.rst | 2 +- docs/sphinx/api/indices.rst | 2 +- docs/sphinx/api/inference.rst | 2 +- docs/sphinx/api/ingest-pipelines.rst | 2 +- docs/sphinx/api/license.rst | 2 +- docs/sphinx/api/logstash.rst | 2 +- docs/sphinx/api/migration.rst | 2 +- docs/sphinx/api/ml.rst | 2 +- docs/sphinx/api/monitoring.rst | 2 +- docs/sphinx/api/nodes.rst | 2 +- docs/sphinx/api/query-rules.rst | 2 +- docs/sphinx/api/rollup-indices.rst | 2 +- docs/sphinx/api/search-application.rst | 2 +- docs/sphinx/api/searchable-snapshots.rst | 2 +- docs/sphinx/api/security.rst | 2 +- docs/sphinx/api/shutdown.rst | 2 +- docs/sphinx/api/snapshot-lifecycle-management.rst | 2 +- docs/sphinx/api/snapshots.rst | 2 +- docs/sphinx/api/snapshottable-features.rst | 2 +- docs/sphinx/api/sql.rst | 2 +- docs/sphinx/api/synonyms.rst | 2 +- docs/sphinx/api/tasks.rst | 2 +- docs/sphinx/api/text-structure.rst | 2 +- docs/sphinx/api/tls-ssl.rst | 2 +- docs/sphinx/api/transforms.rst | 2 +- docs/sphinx/api/watcher.rst | 2 +- docs/sphinx/api/x-pack.rst | 2 +- docs/sphinx/exceptions.rst | 2 +- 42 files changed, 51 insertions(+), 42 deletions(-) create mode 100644 docs/sphinx/api/async-search.rst diff --git a/docs/sphinx/api.rst b/docs/sphinx/api.rst index 2198900c0..979341034 100644 --- a/docs/sphinx/api.rst +++ b/docs/sphinx/api.rst @@ -17,6 +17,7 @@ arguments are required for all calls. :maxdepth: 1 api/elasticsearch + api/async-search api/autoscaling api/cat api/ccr diff --git a/docs/sphinx/api/async-search.rst b/docs/sphinx/api/async-search.rst new file mode 100644 index 000000000..2355c74b9 --- /dev/null +++ b/docs/sphinx/api/async-search.rst @@ -0,0 +1,10 @@ +.. _async_search: + +Async Search +------------ + +.. py:module:: elasticsearch.client + :no-index: + +.. autoclass:: AsyncSearchClient + :members: diff --git a/docs/sphinx/api/autoscaling.rst b/docs/sphinx/api/autoscaling.rst index 1123af250..f1c8e8a1e 100644 --- a/docs/sphinx/api/autoscaling.rst +++ b/docs/sphinx/api/autoscaling.rst @@ -3,7 +3,7 @@ Autoscaling ----------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: AutoscalingClient :members: diff --git a/docs/sphinx/api/cat.rst b/docs/sphinx/api/cat.rst index 515dddf69..bb398b930 100644 --- a/docs/sphinx/api/cat.rst +++ b/docs/sphinx/api/cat.rst @@ -3,7 +3,7 @@ Cat --- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: CatClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/ccr.rst b/docs/sphinx/api/ccr.rst index c0806ef1d..9b1193e7d 100644 --- a/docs/sphinx/api/ccr.rst +++ b/docs/sphinx/api/ccr.rst @@ -3,7 +3,7 @@ Cross-Cluster Replication (CCR) ------------------------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: CcrClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/cluster.rst b/docs/sphinx/api/cluster.rst index feb1b8137..a0260f970 100644 --- a/docs/sphinx/api/cluster.rst +++ b/docs/sphinx/api/cluster.rst @@ -3,7 +3,7 @@ Cluster ------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: ClusterClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/connector.rst b/docs/sphinx/api/connector.rst index 8e62b1d2b..0affee508 100644 --- a/docs/sphinx/api/connector.rst +++ b/docs/sphinx/api/connector.rst @@ -3,7 +3,7 @@ Connector --------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: ConnectorClient :members: diff --git a/docs/sphinx/api/dangling-indices.rst b/docs/sphinx/api/dangling-indices.rst index 7fb88aa3f..e5ca164f5 100644 --- a/docs/sphinx/api/dangling-indices.rst +++ b/docs/sphinx/api/dangling-indices.rst @@ -3,7 +3,7 @@ Dangling Indices ---------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: DanglingIndicesClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/elasticsearch.rst b/docs/sphinx/api/elasticsearch.rst index 1a1a25e85..64df4540b 100644 --- a/docs/sphinx/api/elasticsearch.rst +++ b/docs/sphinx/api/elasticsearch.rst @@ -3,9 +3,7 @@ Elasticsearch ------------- -.. py:module:: elasticsearch +.. py:module:: elasticsearch.client .. autoclass:: Elasticsearch :members: - -.. py:module:: elasticsearch.client \ No newline at end of file diff --git a/docs/sphinx/api/enrich-policies.rst b/docs/sphinx/api/enrich-policies.rst index e3c30a86b..84c24ff52 100644 --- a/docs/sphinx/api/enrich-policies.rst +++ b/docs/sphinx/api/enrich-policies.rst @@ -3,7 +3,7 @@ Enrich Policies --------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: EnrichClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/eql.rst b/docs/sphinx/api/eql.rst index 29c9ce9d4..c3baf1081 100644 --- a/docs/sphinx/api/eql.rst +++ b/docs/sphinx/api/eql.rst @@ -3,7 +3,7 @@ Event Query Language (EQL) -------------------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: EqlClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/esql.rst b/docs/sphinx/api/esql.rst index f38dda764..f9fc84531 100644 --- a/docs/sphinx/api/esql.rst +++ b/docs/sphinx/api/esql.rst @@ -3,7 +3,7 @@ ES|QL ----- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: EsqlClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/fleet.rst b/docs/sphinx/api/fleet.rst index 9851b2f56..333198634 100644 --- a/docs/sphinx/api/fleet.rst +++ b/docs/sphinx/api/fleet.rst @@ -3,7 +3,7 @@ Fleet ----- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: FleetClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/graph-explore.rst b/docs/sphinx/api/graph-explore.rst index a83ef3a9d..4bc3af87a 100644 --- a/docs/sphinx/api/graph-explore.rst +++ b/docs/sphinx/api/graph-explore.rst @@ -3,7 +3,7 @@ Graph Explore ------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: GraphClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/index-lifecycle-management.rst b/docs/sphinx/api/index-lifecycle-management.rst index 9eeef1fbf..def94fa16 100644 --- a/docs/sphinx/api/index-lifecycle-management.rst +++ b/docs/sphinx/api/index-lifecycle-management.rst @@ -3,7 +3,7 @@ Index Lifecycle Management (ILM) -------------------------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: IlmClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/indices.rst b/docs/sphinx/api/indices.rst index 55fc67b05..9523a3558 100644 --- a/docs/sphinx/api/indices.rst +++ b/docs/sphinx/api/indices.rst @@ -3,7 +3,7 @@ Indices ------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: IndicesClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/inference.rst b/docs/sphinx/api/inference.rst index 1f4d371c2..11183ed1e 100644 --- a/docs/sphinx/api/inference.rst +++ b/docs/sphinx/api/inference.rst @@ -3,7 +3,7 @@ Inference --------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: InferenceClient :members: diff --git a/docs/sphinx/api/ingest-pipelines.rst b/docs/sphinx/api/ingest-pipelines.rst index c2ea2efcd..69d19f6d9 100644 --- a/docs/sphinx/api/ingest-pipelines.rst +++ b/docs/sphinx/api/ingest-pipelines.rst @@ -3,7 +3,7 @@ Ingest Pipelines ---------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: IngestClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/license.rst b/docs/sphinx/api/license.rst index e73c6bbbc..cad153a54 100644 --- a/docs/sphinx/api/license.rst +++ b/docs/sphinx/api/license.rst @@ -3,7 +3,7 @@ License ------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: LicenseClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/logstash.rst b/docs/sphinx/api/logstash.rst index b8a00a5be..2fc1b855d 100644 --- a/docs/sphinx/api/logstash.rst +++ b/docs/sphinx/api/logstash.rst @@ -3,7 +3,7 @@ Logstash -------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: LogstashClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/migration.rst b/docs/sphinx/api/migration.rst index 83d08e46b..75e652e29 100644 --- a/docs/sphinx/api/migration.rst +++ b/docs/sphinx/api/migration.rst @@ -3,7 +3,7 @@ Migration --------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: MigrationClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/ml.rst b/docs/sphinx/api/ml.rst index 124cbeb4a..1a0a14bdc 100644 --- a/docs/sphinx/api/ml.rst +++ b/docs/sphinx/api/ml.rst @@ -3,7 +3,7 @@ Machine Learning (ML) --------------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: MlClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/monitoring.rst b/docs/sphinx/api/monitoring.rst index 3bfb8b4a3..7d9185d9f 100644 --- a/docs/sphinx/api/monitoring.rst +++ b/docs/sphinx/api/monitoring.rst @@ -3,7 +3,7 @@ Monitoring ---------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: MonitoringClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/nodes.rst b/docs/sphinx/api/nodes.rst index f1b1fabae..7dbc48467 100644 --- a/docs/sphinx/api/nodes.rst +++ b/docs/sphinx/api/nodes.rst @@ -3,7 +3,7 @@ Nodes ----- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: NodesClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/query-rules.rst b/docs/sphinx/api/query-rules.rst index adcfda99e..64e450213 100644 --- a/docs/sphinx/api/query-rules.rst +++ b/docs/sphinx/api/query-rules.rst @@ -3,7 +3,7 @@ Query rules ----------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: QueryRulesClient :members: diff --git a/docs/sphinx/api/rollup-indices.rst b/docs/sphinx/api/rollup-indices.rst index ea4026811..55663fc1b 100644 --- a/docs/sphinx/api/rollup-indices.rst +++ b/docs/sphinx/api/rollup-indices.rst @@ -3,7 +3,7 @@ Rollup Indices -------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: RollupClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/search-application.rst b/docs/sphinx/api/search-application.rst index e07fb2fef..9c49f67e8 100644 --- a/docs/sphinx/api/search-application.rst +++ b/docs/sphinx/api/search-application.rst @@ -3,7 +3,7 @@ Search Applications ------------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: SearchApplicationClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/searchable-snapshots.rst b/docs/sphinx/api/searchable-snapshots.rst index 406320593..6f0545d42 100644 --- a/docs/sphinx/api/searchable-snapshots.rst +++ b/docs/sphinx/api/searchable-snapshots.rst @@ -3,7 +3,7 @@ Searchable Snapshots -------------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: SearchableSnapshotsClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/security.rst b/docs/sphinx/api/security.rst index 2f77c6aa7..84227e415 100644 --- a/docs/sphinx/api/security.rst +++ b/docs/sphinx/api/security.rst @@ -3,7 +3,7 @@ Security -------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: SecurityClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/shutdown.rst b/docs/sphinx/api/shutdown.rst index 097fad489..245f4d56a 100644 --- a/docs/sphinx/api/shutdown.rst +++ b/docs/sphinx/api/shutdown.rst @@ -3,7 +3,7 @@ Shutdown -------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: ShutdownClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/snapshot-lifecycle-management.rst b/docs/sphinx/api/snapshot-lifecycle-management.rst index 102b06ffc..945f71362 100644 --- a/docs/sphinx/api/snapshot-lifecycle-management.rst +++ b/docs/sphinx/api/snapshot-lifecycle-management.rst @@ -3,7 +3,7 @@ Snapshot Lifecycle Management (SLM) ----------------------------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: SlmClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/snapshots.rst b/docs/sphinx/api/snapshots.rst index 050d2648c..6d2b65f7f 100644 --- a/docs/sphinx/api/snapshots.rst +++ b/docs/sphinx/api/snapshots.rst @@ -3,7 +3,7 @@ Snapshots --------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: SnapshotClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/snapshottable-features.rst b/docs/sphinx/api/snapshottable-features.rst index 19b6f8ac9..cae42dae5 100644 --- a/docs/sphinx/api/snapshottable-features.rst +++ b/docs/sphinx/api/snapshottable-features.rst @@ -3,7 +3,7 @@ Snapshottable Features ---------------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: FeaturesClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/sql.rst b/docs/sphinx/api/sql.rst index 30b1d816c..4011f382d 100644 --- a/docs/sphinx/api/sql.rst +++ b/docs/sphinx/api/sql.rst @@ -3,7 +3,7 @@ SQL --- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: SqlClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/synonyms.rst b/docs/sphinx/api/synonyms.rst index 787a5e4f1..daad2bbd8 100644 --- a/docs/sphinx/api/synonyms.rst +++ b/docs/sphinx/api/synonyms.rst @@ -3,7 +3,7 @@ Synonyms -------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: SynonymsClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/tasks.rst b/docs/sphinx/api/tasks.rst index 363b5de1b..1df9ed706 100644 --- a/docs/sphinx/api/tasks.rst +++ b/docs/sphinx/api/tasks.rst @@ -3,7 +3,7 @@ Tasks ----- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: TasksClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/text-structure.rst b/docs/sphinx/api/text-structure.rst index b57ccd37d..c5e2184f0 100644 --- a/docs/sphinx/api/text-structure.rst +++ b/docs/sphinx/api/text-structure.rst @@ -3,7 +3,7 @@ Text Structure -------------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: TextStructureClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/tls-ssl.rst b/docs/sphinx/api/tls-ssl.rst index 65e571aba..8228fe4b7 100644 --- a/docs/sphinx/api/tls-ssl.rst +++ b/docs/sphinx/api/tls-ssl.rst @@ -3,7 +3,7 @@ TLS/SSL ------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: SslClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/transforms.rst b/docs/sphinx/api/transforms.rst index 2b9e9e4e7..7b9e24aef 100644 --- a/docs/sphinx/api/transforms.rst +++ b/docs/sphinx/api/transforms.rst @@ -3,7 +3,7 @@ Transforms ---------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: TransformClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/watcher.rst b/docs/sphinx/api/watcher.rst index a90b7ee13..4b8c11db6 100644 --- a/docs/sphinx/api/watcher.rst +++ b/docs/sphinx/api/watcher.rst @@ -3,7 +3,7 @@ Watcher ------- .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: WatcherClient :members: \ No newline at end of file diff --git a/docs/sphinx/api/x-pack.rst b/docs/sphinx/api/x-pack.rst index 3583a0880..cd253d1d5 100644 --- a/docs/sphinx/api/x-pack.rst +++ b/docs/sphinx/api/x-pack.rst @@ -3,7 +3,7 @@ X-Pack ------ .. py:module:: elasticsearch.client - :noindex: + :no-index: .. autoclass:: XPackClient :members: \ No newline at end of file diff --git a/docs/sphinx/exceptions.rst b/docs/sphinx/exceptions.rst index 3c8a32dab..e766cfeab 100644 --- a/docs/sphinx/exceptions.rst +++ b/docs/sphinx/exceptions.rst @@ -4,7 +4,7 @@ Exceptions & Warnings ===================== .. py:module:: elasticsearch - :noindex: + :no-index: API Errors ----------