Skip to content

Commit 3928af6

Browse files
barseghyanarturbarseghyanartur
committed
Up docs
1 parent 0715b70 commit 3928af6

17 files changed

+433
-252
lines changed

‎docs/Makefile‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Minimal makefile for Sphinx documentation
22
#
33

4-
# You can set these variables from the command line.
5-
SPHINXOPTS =
6-
SPHINXBUILD = sphinx-build
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
78
SOURCEDIR = .
89
BUILDDIR = _build
910

@@ -16,4 +17,4 @@ help:
1617
# Catch-all target: route all unknown targets to Sphinx using the new
1718
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1819
%: Makefile
19-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/django_elasticsearch_dsl_drf.fields.rst‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,30 @@ django\_elasticsearch\_dsl\_drf.fields.common module
88
----------------------------------------------------
99

1010
.. automodule:: django_elasticsearch_dsl_drf.fields.common
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
1414

1515
django\_elasticsearch\_dsl\_drf.fields.helpers module
1616
-----------------------------------------------------
1717

1818
.. automodule:: django_elasticsearch_dsl_drf.fields.helpers
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
2222

2323
django\_elasticsearch\_dsl\_drf.fields.nested\_fields module
2424
------------------------------------------------------------
2525

2626
.. automodule:: django_elasticsearch_dsl_drf.fields.nested_fields
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
30-
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
3130

3231
Module contents
3332
---------------
3433

3534
.. automodule:: django_elasticsearch_dsl_drf.fields
36-
:members:
37-
:undoc-members:
38-
:show-inheritance:
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎docs/django_elasticsearch_dsl_drf.filter_backends.aggregations.rst‎

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,30 @@ django\_elasticsearch\_dsl\_drf.filter\_backends.aggregations.bucket\_aggregatio
88
-----------------------------------------------------------------------------------------
99

1010
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.aggregations.bucket_aggregations
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
1414

1515
django\_elasticsearch\_dsl\_drf.filter\_backends.aggregations.metrics\_aggregations module
1616
------------------------------------------------------------------------------------------
1717

1818
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.aggregations.metrics_aggregations
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
2222

2323
django\_elasticsearch\_dsl\_drf.filter\_backends.aggregations.pipeline\_aggregations module
2424
-------------------------------------------------------------------------------------------
2525

2626
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.aggregations.pipeline_aggregations
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
30-
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
3130

3231
Module contents
3332
---------------
3433

3534
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.aggregations
36-
:members:
37-
:undoc-members:
38-
:show-inheritance:
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:

‎docs/django_elasticsearch_dsl_drf.filter_backends.filtering.rst‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,46 @@ django\_elasticsearch\_dsl\_drf.filter\_backends.filtering.common module
88
------------------------------------------------------------------------
99

1010
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.filtering.common
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
1414

1515
django\_elasticsearch\_dsl\_drf.filter\_backends.filtering.geo\_spatial module
1616
------------------------------------------------------------------------------
1717

1818
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.filtering.geo_spatial
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
2222

2323
django\_elasticsearch\_dsl\_drf.filter\_backends.filtering.ids module
2424
---------------------------------------------------------------------
2525

2626
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.filtering.ids
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
3030

3131
django\_elasticsearch\_dsl\_drf.filter\_backends.filtering.nested module
3232
------------------------------------------------------------------------
3333

3434
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.filtering.nested
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
3838

3939
django\_elasticsearch\_dsl\_drf.filter\_backends.filtering.post\_filter module
4040
------------------------------------------------------------------------------
4141

4242
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.filtering.post_filter
43-
:members:
44-
:undoc-members:
45-
:show-inheritance:
46-
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
4746

4847
Module contents
4948
---------------
5049

5150
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.filtering
52-
:members:
53-
:undoc-members:
54-
:show-inheritance:
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

‎docs/django_elasticsearch_dsl_drf.filter_backends.ordering.rst‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,22 @@ django\_elasticsearch\_dsl\_drf.filter\_backends.ordering.common module
88
-----------------------------------------------------------------------
99

1010
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.ordering.common
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
1414

1515
django\_elasticsearch\_dsl\_drf.filter\_backends.ordering.geo\_spatial module
1616
-----------------------------------------------------------------------------
1717

1818
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.ordering.geo_spatial
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
22-
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
2322

2423
Module contents
2524
---------------
2625

2726
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.ordering
28-
:members:
29-
:undoc-members:
30-
:show-inheritance:
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:

‎docs/django_elasticsearch_dsl_drf.filter_backends.rst‎

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@ Subpackages
55
-----------
66

77
.. toctree::
8+
:maxdepth: 20
89

9-
django_elasticsearch_dsl_drf.filter_backends.aggregations
10-
django_elasticsearch_dsl_drf.filter_backends.filtering
11-
django_elasticsearch_dsl_drf.filter_backends.ordering
12-
django_elasticsearch_dsl_drf.filter_backends.search
13-
django_elasticsearch_dsl_drf.filter_backends.suggester
10+
django_elasticsearch_dsl_drf.filter_backends.aggregations
11+
django_elasticsearch_dsl_drf.filter_backends.filtering
12+
django_elasticsearch_dsl_drf.filter_backends.ordering
13+
django_elasticsearch_dsl_drf.filter_backends.search
14+
django_elasticsearch_dsl_drf.filter_backends.suggester
1415

1516
Submodules
1617
----------
@@ -19,31 +20,38 @@ django\_elasticsearch\_dsl\_drf.filter\_backends.faceted\_search module
1920
-----------------------------------------------------------------------
2021

2122
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.faceted_search
22-
:members:
23-
:undoc-members:
24-
:show-inheritance:
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
2526

2627
django\_elasticsearch\_dsl\_drf.filter\_backends.highlight module
2728
-----------------------------------------------------------------
2829

2930
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.highlight
30-
:members:
31-
:undoc-members:
32-
:show-inheritance:
31+
:members:
32+
:undoc-members:
33+
:show-inheritance:
3334

3435
django\_elasticsearch\_dsl\_drf.filter\_backends.mixins module
3536
--------------------------------------------------------------
3637

3738
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.mixins
38-
:members:
39-
:undoc-members:
40-
:show-inheritance:
39+
:members:
40+
:undoc-members:
41+
:show-inheritance:
4142

43+
django\_elasticsearch\_dsl\_drf.filter\_backends.source module
44+
--------------------------------------------------------------
45+
46+
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.source
47+
:members:
48+
:undoc-members:
49+
:show-inheritance:
4250

4351
Module contents
4452
---------------
4553

4654
.. automodule:: django_elasticsearch_dsl_drf.filter_backends
47-
:members:
48-
:undoc-members:
49-
:show-inheritance:
55+
:members:
56+
:undoc-members:
57+
:show-inheritance:

‎docs/django_elasticsearch_dsl_drf.filter_backends.search.query_backends.rst‎

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -8,63 +8,62 @@ django\_elasticsearch\_dsl\_drf.filter\_backends.search.query\_backends.base mod
88
-----------------------------------------------------------------------------------
99

1010
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.search.query_backends.base
11-
:members:
12-
:undoc-members:
13-
:show-inheritance:
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
1414

1515
django\_elasticsearch\_dsl\_drf.filter\_backends.search.query\_backends.match module
1616
------------------------------------------------------------------------------------
1717

1818
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.search.query_backends.match
19-
:members:
20-
:undoc-members:
21-
:show-inheritance:
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
2222

2323
django\_elasticsearch\_dsl\_drf.filter\_backends.search.query\_backends.match\_phrase module
2424
--------------------------------------------------------------------------------------------
2525

2626
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.search.query_backends.match_phrase
27-
:members:
28-
:undoc-members:
29-
:show-inheritance:
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
3030

3131
django\_elasticsearch\_dsl\_drf.filter\_backends.search.query\_backends.match\_phrase\_prefix module
3232
----------------------------------------------------------------------------------------------------
3333

3434
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.search.query_backends.match_phrase_prefix
35-
:members:
36-
:undoc-members:
37-
:show-inheritance:
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
3838

3939
django\_elasticsearch\_dsl\_drf.filter\_backends.search.query\_backends.multi\_match module
4040
-------------------------------------------------------------------------------------------
4141

4242
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.search.query_backends.multi_match
43-
:members:
44-
:undoc-members:
45-
:show-inheritance:
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
4646

4747
django\_elasticsearch\_dsl\_drf.filter\_backends.search.query\_backends.nested module
4848
-------------------------------------------------------------------------------------
4949

5050
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.search.query_backends.nested
51-
:members:
52-
:undoc-members:
53-
:show-inheritance:
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
5454

5555
django\_elasticsearch\_dsl\_drf.filter\_backends.search.query\_backends.simple\_query\_string module
5656
----------------------------------------------------------------------------------------------------
5757

5858
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.search.query_backends.simple_query_string
59-
:members:
60-
:undoc-members:
61-
:show-inheritance:
62-
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
6362

6463
Module contents
6564
---------------
6665

6766
.. automodule:: django_elasticsearch_dsl_drf.filter_backends.search.query_backends
68-
:members:
69-
:undoc-members:
70-
:show-inheritance:
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:

0 commit comments

Comments
 (0)