8000 Remove FAQ on 'Search' -- already referenced in search file by jakeprojects · Pull Request #15591 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Remove FAQ on 'Search' -- already referenced in search file #15591

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 19, 2019
Merged

Remove FAQ on 'Search' -- already referenced in search file #15591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af588cf
Remove FAQ on 'Search' -- already referenced in search file
jakeprojects Nov 2, 2019
2689cdc
Fix missing link
timhoffm Nov 12, 2019
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
3 changes: 1 addition & 2 deletions doc/_templates/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ <h1 id="search-documentation">{{ _('Search') }}</h1>
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 <i>code example</i>) in your
search, e.g., "codex ellipse";
see <a href="{{ pathto('faq/howto_faq.html#search-examples') }}">search&nbsp;examples</a>.
search, e.g., "codex ellipse".
</p>
<form action="" method="get">
<input type="text" name="q" value="" />
Expand Down
19 changes: 1 addition & 18 deletions doc/faq/howto_faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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``.
0