From af588cf899c59ad08dbd38491ff47af48a732aa9 Mon Sep 17 00:00:00 2001 From: Jake Lee Date: Sat, 2 Nov 2019 12:20:35 +0000 Subject: [PATCH 1/2] Remove FAQ on 'Search' -- already referenced in search file --- doc/_templates/search.html | 3 +-- doc/faq/howto_faq.rst | 17 ----------------- 2 files changed, 1 insertion(+), 19 deletions(-) diff --git a/doc/_templates/search.html b/doc/_templates/search.html index 3a398cdd0667..c2ad215c877c 100644 --- a/doc/_templates/search.html +++ b/doc/_templates/search.html @@ -13,8 +13,7 @@

{{ _('Search') }}

words. Pages containing less words won't appear in the result list.{% endtrans %} If you want to limit your search to working code examples, include the keyword "codex" (mnemonic for code example) in your - search, e.g., "codex ellipse"; - see search examples. + search, e.g., "codex ellipse".

diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst index 46fce65d03d8..e600d44215bf 100644 --- a/doc/faq/howto_faq.rst +++ b/doc/faq/howto_faq.rst @@ -720,20 +720,3 @@ has written a nice `article on how to make html click maps with Matplotlib agg PNGs. We would also like to add this functionality to SVG. If you are interested in contributing to these efforts that would be great. - - -.. _how-to-search-examples: - -How to search for examples -========================== - -The nearly 300 code :ref:`examples-index` included with the Matplotlib -source distribution are full-text searchable from the :ref:`search` -page, but sometimes when you search, you get a lot of results from the -:ref:`api-index` or other documentation that you may not be interested -in if you just want to find a complete, free-standing, working piece -of example code. To facilitate example searches, we have tagged every -code example page with the keyword ``codex`` for *code example* which -shouldn't appear anywhere else on this site except in the FAQ. -So if you want to search for an example that uses an -ellipse, :ref:`search` for ``codex ellipse``. From 2689cdcf664183b8d70c616d45b6f9e4e59d27e3 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Wed, 13 Nov 2019 00:11:08 +0100 Subject: [PATCH 2/2] Fix missing link --- doc/faq/howto_faq.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst index e600d44215bf..09c13d6d35c0 100644 --- a/doc/faq/howto_faq.rst +++ b/doc/faq/howto_faq.rst @@ -630,7 +630,7 @@ Contribute to Matplotlib documentation Matplotlib is a big library, which is used in many ways, and the documentation has only scratched the surface of everything it can do. So far, the place most people have learned all these features are -through studying the examples (:ref:`how-to-search-examples`), which is a +through studying the :ref:`examples-index`, which is a recommended and great way to learn, but it would be nice to have more official narrative documentation guiding people through all the dark corners. This is where you come in.