Skip to content

Commit 5e643e9

Browse files
pquentinpquentin
committed
Fix all warnings in docs
1 parent 1602d6b commit 5e643e9

25 files changed

+229
-125
lines changed

‎docs/sphinx/api.rst

Lines changed: 25 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -14,129 +14,29 @@ arguments are required for all
1414
aliased as ``from_``.
1515

1616

17-
Elasticsearch
18-
-------------
1917

20-
.. py:module:: elasticsearch_serverless
21-
22-
.. autoclass:: Elasticsearch
23-
:members:
24-
25-
.. py:module:: elasticsearch_serverless.client
26-
27-
Async Search
28-
------------
29-
30-
.. autoclass:: AsyncSearchClient
31-
:members:
32-
33-
Cat
34-
---
35-
36-
.. autoclass:: CatClient
37-
:members:
38-
39-
Cluster
40-
-------
41-
42-
.. autoclass:: ClusterClient
43-
:members:
44-
45-
Connector
46-
---------
47-
.. py:module:: elasticsearch.client
48-
:noindex:
49-
50-
.. autoclass:: ConnectorClient
51-
:members:
52-
53-
Enrich Policies
54-
---------------
55-
56-
.. autoclass:: EnrichClient
57-
:members:
58-
59-
Event Query Language (EQL)
60-
--------------------------
61-
62-
.. autoclass:: EqlClient
63-
:members:
64-
65-
66-
ES|QL
67-
-----
68-
69-
.. autoclass:: EqlClient
70-
:members:
71-
72-
Graph Explore
73-
-------------
74-
75-
.. autoclass:: GraphClient
76-
:members:
77-
78-
Indices
79-
-------
80-
81-
.. autoclass:: IndicesClient
82-
:members:
83-
84-
Inference
85-
---------
86-
87-
.. autoclass:: InferenceClient
88-
:members:
89-
90-
Ingest Pipelines
91-
----------------
92-
93-
.. autoclass:: IngestClient
94-
:members:
95-
96-
License
97-
-------
98-
99-
.. autoclass:: LicenseClient
100-
:members:
101-
102-
Logstash
103-
--------
104-
105-
.. autoclass:: LogstashClient
106-
:members:
107-
108-
Machine Learning (ML)
109-
---------------------
110-
111-
.. autoclass:: MlClient
112-
:members:
113-
114-
Monitoring
115-
----------
116-
117-
.. autoclass:: MonitoringClient
118-
:members:
119-
120-
Security
121-
--------
122-
123-
.. autoclass:: SecurityClient
124-
:members:
125-
126-
SQL
127-
---
128-
129-
.. autoclass:: SqlClient
130-
:members:
131-
132-
Tasks
133-
-----
134-
135-
.. autoclass:: TasksClient
136-
:members:
137-
138-
Transforms
139-
----------
140-
141-
.. autoclass:: TransformClient
142-
:members:
18+
.. toctree::
19+
:maxdepth: 1
20+
21+
api/elasticsearch
22+
api/async-search
23+
api/cat
24+
api/cluster
25+
api/connector
26+
api/enrich-policies
27+
api/eql
28+
api/esql
29+
api/indices
30+
api/inference
31+
api/ingest-pipelines
32+
api/license
33+
api/logstash
34+
api/ml
35+
api/nodes
36+
api/query-rules
37+
api/search-application
38+
api/security
39+
api/sql
40+
api/synonyms
41+
api/tasks
42+
api/transforms

‎docs/sphinx/api/async-search.rst

Lines changed: 10 additions & 0 deletions
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_serverless.client
7+
:no-index:
8+
9+
.. autoclass:: AsyncSearchClient
10+
:members:

‎docs/sphinx/api/cat.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _cat:
2+
3+
Cat
4+
---
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: CatClient
9+
:members:

‎docs/sphinx/api/cluster.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _cluster:
2+
3+
Cluster
4+
-------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: ClusterClient
9+
:members:

‎docs/sphinx/api/connector.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _connector:
2+
3+
Connector
4+
---------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: ConnectorClient
9+
:members:

‎docs/sphinx/api/elasticsearch.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _elasticsearch:
2+
3+
Elasticsearch
4+
-------------
5+
6+
.. py:module:: elasticsearch_serverless
7+
8+
.. autoclass:: Elasticsearch
9+
:members:

‎docs/sphinx/api/enrich-policies.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _enrich-policies:
2+
3+
Enrich Policies
4+
---------------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: EnrichClient
9+
:members:

‎docs/sphinx/api/eql.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _eql:
2+
3+
Event Query Language (EQL)
4+
--------------------------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: EqlClient
9+
:members:

‎docs/sphinx/api/esql.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _esql:
2+
3+
ES|QL
4+
-----
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: EsqlClient
9+
:members:

‎docs/sphinx/api/indices.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _indices:
2+
3+
Indices
4+
-------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: IndicesClient
9+
:members:

‎docs/sphinx/api/inference.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _inference:
2+
3+
Inference
4+
---------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: InferenceClient
9+
:members:

‎docs/sphinx/api/ingest-pipelines.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _ingest-pipelines:
2+
3+
Ingest Pipelines
4+
----------------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: IngestClient
9+
:members:

‎docs/sphinx/api/license.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _license:
2+
3+
License
4+
-------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: LicenseClient
9+
:members:

‎docs/sphinx/api/logstash.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _logstash:
2+
3+
Logstash
4+
--------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: LogstashClient
9+
:members:

‎docs/sphinx/api/ml.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _ml:
2+
3+
Machine Learning (ML)
4+
---------------------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: MlClient
9+
:members:

‎docs/sphinx/api/nodes.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _nodes:
2+
3+
Nodes
4+
-----
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: NodesClient
9+
:members:

‎docs/sphinx/api/query-rules.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _query-rules:
2+
3+
Query rules
4+
-----------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: QueryRulesClient
9+
:members:

‎docs/sphinx/api/search-application.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _search-application:
2+
3+
Search Applications
4+
-------------------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: SearchApplicationClient
9+
:members:

‎docs/sphinx/api/security.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _security:
2+
3+
Security
4+
--------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: SecurityClient
9+
:members:

‎docs/sphinx/api/sql.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _sql:
2+
3+
SQL
4+
---
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: SqlClient
9+
:members:

‎docs/sphinx/api/synonyms.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _synonyms:
2+
3+
Synonyms
4+
--------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: SynonymsClient
9+
:members:

‎docs/sphinx/api/tasks.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _tasks:
2+
3+
Tasks
4+
-----
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: TasksClient
9+
:members:

‎docs/sphinx/api/transforms.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. _transforms:
2+
3+
Transforms
4+
----------
5+
.. py:module:: elasticsearch_serverless.client
6+
:no-index:
7+
8+
.. autoclass:: TransformClient
9+
:members:

0 commit comments

Comments
 (0)