Skip to content

Commit cefe19b

Browse files
github-actions[bot]pquentin
github-actions[bot]
and
pquentin
authored
[Backport 8.15] Fix reference docs (#2629)
(cherry picked from commit d4eb86e) Co-authored-by: Quentin Pradet <[email protected]>
1 parent 90fddf4 commit cefe19b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+51
-42
lines changed

Diff for: ‎docs/sphinx/api.rst

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ arguments are required for all calls.
1717
:maxdepth: 1
1818

1919
api/elasticsearch
20+
api/async-search
2021
api/autoscaling
2122
api/cat
2223
api/ccr

Diff for: ‎docs/sphinx/api/async-search.rst

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. _async_search:
2+
3+
Async Search
4+
------------
5+
6+
.. py:module:: elasticsearch.client
7+
:no-index:
8+
9+
.. autoclass:: AsyncSearchClient
10+
:members:

Diff for: ‎docs/sphinx/api/autoscaling.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Autoscaling
44
-----------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: AutoscalingClient
99
:members:

Diff for: ‎docs/sphinx/api/cat.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Cat
44
---
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: CatClient
99
:members:

Diff for: ‎docs/sphinx/api/ccr.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Cross-Cluster Replication (CCR)
44
-------------------------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: CcrClient
99
:members:

Diff for: ‎docs/sphinx/api/cluster.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Cluster
44
-------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: ClusterClient
99
:members:

Diff for: ‎docs/sphinx/api/connector.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Connector
44
---------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: ConnectorClient
99
:members:

Diff for: ‎docs/sphinx/api/dangling-indices.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Dangling Indices
44
----------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: DanglingIndicesClient
99
:members:

Diff for: ‎docs/sphinx/api/elasticsearch.rst

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
Elasticsearch
44
-------------
55

6-
.. py:module:: elasticsearch
6+
.. py:module:: elasticsearch.client
77
88
.. autoclass:: Elasticsearch
99
:members:
10-
11-
.. py:module:: elasticsearch.client

Diff for: ‎docs/sphinx/api/enrich-policies.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Enrich Policies
44
---------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: EnrichClient
99
:members:

Diff for: ‎docs/sphinx/api/eql.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Event Query Language (EQL)
44
--------------------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: EqlClient
99
:members:

Diff for: ‎docs/sphinx/api/esql.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
ES|QL
44
-----
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: EsqlClient
99
:members:

Diff for: ‎docs/sphinx/api/fleet.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Fleet
44
-----
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: FleetClient
99
:members:

Diff for: ‎docs/sphinx/api/graph-explore.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Graph Explore
44
-------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: GraphClient
99
:members:

Diff for: ‎docs/sphinx/api/index-lifecycle-management.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Index Lifecycle Management (ILM)
44
--------------------------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: IlmClient
99
:members:

Diff for: ‎docs/sphinx/api/indices.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Indices
44
-------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: IndicesClient
99
:members:

Diff for: ‎docs/sphinx/api/inference.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Inference
44
---------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: InferenceClient
99
:members:

Diff for: ‎docs/sphinx/api/ingest-pipelines.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Ingest Pipelines
44
----------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: IngestClient
99
:members:

Diff for: ‎docs/sphinx/api/license.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
License
44
-------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: LicenseClient
99
:members:

Diff for: ‎docs/sphinx/api/logstash.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Logstash
44
--------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: LogstashClient
99
:members:

Diff for: ‎docs/sphinx/api/migration.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Migration
44
---------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: MigrationClient
99
:members:

Diff for: ‎docs/sphinx/api/ml.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Machine Learning (ML)
44
---------------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: MlClient
99
:members:

Diff for: ‎docs/sphinx/api/monitoring.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Monitoring
44
----------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: MonitoringClient
99
:members:

Diff for: ‎docs/sphinx/api/nodes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Nodes
44
-----
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: NodesClient
99
:members:

Diff for: ‎docs/sphinx/api/query-rules.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Query rules
44
-----------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: QueryRulesClient
99
:members:

Diff for: ‎docs/sphinx/api/rollup-indices.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Rollup Indices
44
--------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: RollupClient
99
:members:

Diff for: ‎docs/sphinx/api/search-application.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Search Applications
44
-------------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: SearchApplicationClient
99
:members:

Diff for: ‎docs/sphinx/api/searchable-snapshots.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Searchable Snapshots
44
--------------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: SearchableSnapshotsClient
99
:members:

Diff for: ‎docs/sphinx/api/security.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Security
44
--------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: SecurityClient
99
:members:

Diff for: ‎docs/sphinx/api/shutdown.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Shutdown
44
--------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: ShutdownClient
99
:members:

Diff for: ‎docs/sphinx/api/snapshot-lifecycle-management.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Snapshot Lifecycle Management (SLM)
44
-----------------------------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: SlmClient
99
:members:

Diff for: ‎docs/sphinx/api/snapshots.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Snapshots
44
---------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: SnapshotClient
99
:members:

Diff for: ‎docs/sphinx/api/snapshottable-features.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Snapshottable Features
44
----------------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: FeaturesClient
99
:members:

Diff for: ‎docs/sphinx/api/sql.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
SQL
44
---
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: SqlClient
99
:members:

Diff for: ‎docs/sphinx/api/synonyms.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Synonyms
44
--------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: SynonymsClient
99
:members:

Diff for: ‎docs/sphinx/api/tasks.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Tasks
44
-----
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: TasksClient
99
:members:

Diff for: ‎docs/sphinx/api/text-structure.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Text Structure
44
--------------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: TextStructureClient
99
:members:

Diff for: ‎docs/sphinx/api/tls-ssl.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
TLS/SSL
44
-------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: SslClient
99
:members:

Diff for: ‎docs/sphinx/api/transforms.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Transforms
44
----------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: TransformClient
99
:members:

Diff for: ‎docs/sphinx/api/watcher.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Watcher
44
-------
55
.. py:module:: elasticsearch.client
6-
:noindex:
6+
:no-index:
77

88
.. autoclass:: WatcherClient
99
:members:

0 commit comments

Comments
 (0)