Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 8.15] Fix reference docs #2629

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/sphinx/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ arguments are required for all calls.
:maxdepth: 1

api/elasticsearch
api/async-search
api/autoscaling
api/cat
api/ccr
Expand Down
10 changes: 10 additions & 0 deletions docs/sphinx/api/async-search.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. _async_search:

Async Search
------------

.. py:module:: elasticsearch.client
:no-index:

.. autoclass:: AsyncSearchClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/autoscaling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Autoscaling
-----------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: AutoscalingClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/cat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Cat
---
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: CatClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/ccr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Cross-Cluster Replication (CCR)
-------------------------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: CcrClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Cluster
-------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: ClusterClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/connector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Connector
---------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: ConnectorClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/dangling-indices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Dangling Indices
----------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: DanglingIndicesClient
:members:
4 changes: 1 addition & 3 deletions docs/sphinx/api/elasticsearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@
Elasticsearch
-------------

.. py:module:: elasticsearch
.. py:module:: elasticsearch.client
.. autoclass:: Elasticsearch
:members:

.. py:module:: elasticsearch.client
2 changes: 1 addition & 1 deletion docs/sphinx/api/enrich-policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Enrich Policies
---------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: EnrichClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/eql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Event Query Language (EQL)
--------------------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: EqlClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/esql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
ES|QL
-----
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: EsqlClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/fleet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Fleet
-----
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: FleetClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/graph-explore.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Graph Explore
-------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: GraphClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/index-lifecycle-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Index Lifecycle Management (ILM)
--------------------------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: IlmClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/indices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Indices
-------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: IndicesClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/inference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Inference
---------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: InferenceClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/ingest-pipelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Ingest Pipelines
----------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: IngestClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
License
-------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: LicenseClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/logstash.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Logstash
--------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: LogstashClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Migration
---------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: MigrationClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/ml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Machine Learning (ML)
---------------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: MlClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/monitoring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Monitoring
----------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: MonitoringClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Nodes
-----
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: NodesClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/query-rules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Query rules
-----------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: QueryRulesClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/rollup-indices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Rollup Indices
--------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: RollupClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/search-application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Search Applications
-------------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: SearchApplicationClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/searchable-snapshots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Searchable Snapshots
--------------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: SearchableSnapshotsClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Security
--------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: SecurityClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/shutdown.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Shutdown
--------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: ShutdownClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/snapshot-lifecycle-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Snapshot Lifecycle Management (SLM)
-----------------------------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: SlmClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/snapshots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Snapshots
---------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: SnapshotClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/snapshottable-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Snapshottable Features
----------------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: FeaturesClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/sql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
SQL
---
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: SqlClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/synonyms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Synonyms
--------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: SynonymsClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Tasks
-----
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: TasksClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/text-structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Text Structure
--------------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: TextStructureClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/tls-ssl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
TLS/SSL
-------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: SslClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/transforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Transforms
----------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: TransformClient
:members:
2 changes: 1 addition & 1 deletion docs/sphinx/api/watcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Watcher
-------
.. py:module:: elasticsearch.client
:noindex:
:no-index:

.. autoclass:: WatcherClient
:members:
Loading
Loading