Skip to content

Commit 9acc706

Browse files
more on docs
1 parent 3378c9b commit 9acc706

File tree

2 files changed

+42
-20
lines changed

2 files changed

+42
-20
lines changed

docs/faq.rst

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
FAQ
22
===
33
You will find a lot of useful information in the `documentation
4-
<https://django-elasticsearch-dsl-drf.readthedocs.io/>`_.
4+
<https://django-elasticsearch-dsl-drf.readthedocs.io/>`__.
55

66
Additionally, all raised issues that were questions have been marked as
77
`question`, so you could take a look at the
8-
`closed (question) issues <https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/issues?q=is%3Aissue+label%3Aquestion+is%3Aclosed>`_.
8+
`closed (question) issues <https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/issues?q=is%3Aissue+label%3Aquestion+is%3Aclosed>`__.
99

1010
Questions and answers
1111
---------------------
@@ -21,19 +21,24 @@ Yes. There are many ways doing this in Elasticsearch.
2121

2222
To mention a couple:
2323

24-
- You could use partial matching using NGrams. Partially shown `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/0.17.2/advanced_usage_examples.html?highlight=ngram#id8)>`_.
25-
`The basic idea <https://www.elastic.co/guide/en/elasticsearch/guide/current/_ngrams_for_partial_matching.html>`_.
26-
- Use `contains <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/filtering_usage_examples.html?highlight=contains#contains>`_
24+
- You could use partial matching using NGrams. Partially shown
25+
`here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/0.17.2/advanced_usage_examples.html?highlight=ngram#id8)>`__.
26+
`The basic idea <https://www.elastic.co/guide/en/elasticsearch/guide/current/_ngrams_for_partial_matching.html>`__.
27+
- Use `contains <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/filtering_usage_examples.html?highlight=contains#contains>`__
2728
functional filter.
2829

30+
----
31+
2932
**Question**
3033

3134
Can we use Django REST Framework ``serializers.ModelSerializer`` directly?
3235

3336
**Answer**
3437

3538
No, but you could use ``serializers.Serializer``. `Read the docs
36-
<https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html?highlight=serializer#serializer-definition>`_.
39+
<https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html?highlight=serializer#serializer-definition>`__.
40+
41+
----
3742

3843
**Question**
3944

@@ -42,7 +47,7 @@ How can I order search results overall relevance
4247
**Answer**
4348

4449
That's ``_score``. See the following `example
45-
<https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/blob/master/examples/simple/search_indexes/viewsets/book/frontend.py#L206>`_.
50+
<https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/blob/master/examples/simple/search_indexes/viewsets/book/frontend.py#L206>`__.
4651

4752
.. code-block:: python
4853
@@ -51,21 +56,27 @@ That's ``_score``. See the following `example
5156
In the given example, results are sorted by the ``score`` (which is relevance),
5257
then by ``id``, ``title`` and ``price``.
5358

59+
----
60+
5461
**Question**
5562

5663
How can I separate my development/production/acceptance/test indexes?
5764

5865
**Answer**
5966

60-
It's documented `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html#settings>`_.
67+
It's documented `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html#settings>`__.
68+
69+
----
6170

6271
**Question**
6372

6473
How can I sync my database with Elasticsearch indexes.
6574

6675
**Answer**
6776

68-
It's documented `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html#sample-partial-sync-using-custom-signals>`_.
77+
It's documented `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html#sample-partial-sync-using-custom-signals>`__.
78+
79+
----
6980

7081
**Question**
7182

@@ -76,4 +87,4 @@ in settings.
7687
**Answer**
7788

7889
Once of the possible reasons for the mentioned symptom might be `low disk space
79-
<https://discuss.elastic.co/t/forbidden-12-index-read-only-allow-delete-api/110282>`_.
90+
<https://discuss.elastic.co/t/forbidden-12-index-read-only-allow-delete-api/110282>`__.

docs_src/faq.rst

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
FAQ
22
===
33
You will find a lot of useful information in the `documentation
4-
<https://django-elasticsearch-dsl-drf.readthedocs.io/>`_.
4+
<https://django-elasticsearch-dsl-drf.readthedocs.io/>`__.
55

66
Additionally, all raised issues that were questions have been marked as
77
`question`, so you could take a look at the
8-
`closed (question) issues <https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/issues?q=is%3Aissue+label%3Aquestion+is%3Aclosed>`_.
8+
`closed (question) issues <https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/issues?q=is%3Aissue+label%3Aquestion+is%3Aclosed>`__.
99

1010
Questions and answers
1111
---------------------
@@ -21,19 +21,24 @@ Yes. There are many ways doing this in Elasticsearch.
2121

2222
To mention a couple:
2323

24-
- You could use partial matching using NGrams. Partially shown `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/0.17.2/advanced_usage_examples.html?highlight=ngram#id8)>`_.
25-
`The basic idea <https://www.elastic.co/guide/en/elasticsearch/guide/current/_ngrams_for_partial_matching.html>`_.
26-
- Use `contains <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/filtering_usage_examples.html?highlight=contains#contains>`_
24+
- You could use partial matching using NGrams. Partially shown
25+
`here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/0.17.2/advanced_usage_examples.html?highlight=ngram#id8)>`__.
26+
`The basic idea <https://www.elastic.co/guide/en/elasticsearch/guide/current/_ngrams_for_partial_matching.html>`__.
27+
- Use `contains <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/filtering_usage_examples.html?highlight=contains#contains>`__
2728
functional filter.
2829

30+
----
31+
2932
**Question**
3033

3134
Can we use Django REST Framework ``serializers.ModelSerializer`` directly?
3235

3336
**Answer**
3437

3538
No, but you could use ``serializers.Serializer``. `Read the docs
36-
<https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html?highlight=serializer#serializer-definition>`_.
39+
<https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html?highlight=serializer#serializer-definition>`__.
40+
41+
----
3742

3843
**Question**
3944

@@ -42,7 +47,7 @@ How can I order search results overall relevance
4247
**Answer**
4348

4449
That's ``_score``. See the following `example
45-
<https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/blob/master/examples/simple/search_indexes/viewsets/book/frontend.py#L206>`_.
50+
<https://github.com/barseghyanartur/django-elasticsearch-dsl-drf/blob/master/examples/simple/search_indexes/viewsets/book/frontend.py#L206>`__.
4651

4752
.. code-block:: python
4853
@@ -51,21 +56,27 @@ That's ``_score``. See the following `example
5156
In the given example, results are sorted by the ``score`` (which is relevance),
5257
then by ``id``, ``title`` and ``price``.
5358

59+
----
60+
5461
**Question**
5562

5663
How can I separate my development/production/acceptance/test indexes?
5764

5865
**Answer**
5966

60-
It's documented `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html#settings>`_.
67+
It's documented `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html#settings>`__.
68+
69+
----
6170

6271
**Question**
6372

6473
How can I sync my database with Elasticsearch indexes.
6574

6675
**Answer**
6776

68-
It's documented `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html#sample-partial-sync-using-custom-signals>`_.
77+
It's documented `here <https://django-elasticsearch-dsl-drf.readthedocs.io/en/latest/quick_start.html#sample-partial-sync-using-custom-signals>`__.
78+
79+
----
6980

7081
**Question**
7182

@@ -76,4 +87,4 @@ in settings.
7687
**Answer**
7788

7889
Once of the possible reasons for the mentioned symptom might be `low disk space
79-
<https://discuss.elastic.co/t/forbidden-12-index-read-only-allow-delete-api/110282>`_.
90+
<https://discuss.elastic.co/t/forbidden-12-index-read-only-allow-delete-api/110282>`__.

0 commit comments

Comments
 (0)