Skip to content

Add 'noindex' directive for web crawlers to basic theme search results #11700

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 5 commits into from
Oct 3, 2023
Merged

Add 'noindex' directive for web crawlers to basic theme search results #11700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2a3c57e
search.html: add 'noindex' directive to instruct web crawlers that co…
jayaddison Oct 1, 2023
255b20d
search.html: nitpick: apply consistent HTML element indenting
jayaddison Oct 1, 2023
806044b
Add CHANGES entry for #11697
jayaddison Oct 1, 2023
113e8b3
Add test coverage for meta robots 'noindex' element in HTML content b…
jayaddison Oct 2, 2023
0c4ea31
Update CHANGES.rst
AA-Turner Oct 3, 2023
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
2 changes: 2 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Bugs fixed
* #11483: singlehtml builder: Fix MathJax lazy loading when the index does not
contain any math equations.
Patch by Bénédikt Tran.
* #11697: HTML Search: add 'noindex' meta robots tag.
Patch by James Addison.

Testing
-------
Expand Down
5 changes: 3 additions & 2 deletions sphinx/themes/basic/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
<script src="{{ pathto('_static/language_data.js', 1) }}"></script>
{%- endblock %}
{% block extrahead %}
<script src="{{ pathto('searchindex.js', 1) }}" defer></script>
{{ super() }}
<script src="{{ pathto('searchindex.js', 1) }}" defer></script>
<meta name="robots" content="noindex" />
{{ super() }}
{% endblock %}
{% block body %}
<h1 id="search-documentation">{{ _('Search') }}</h1>
Expand Down
3 changes: 3 additions & 0 deletions tests/test_build_html.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,9 @@ def test_html4_error(make_app, tmp_path):
(".//h1", "Generated section"),
(".//a[@href='_sources/otherext.foo.txt']", ''),
],
'search.html': [
(".//meta[@name='robots'][@content='noindex']", ''),
],
}))
@pytest.mark.sphinx('html', tags=['testtag'],
confoverrides={'html_context.hckey_co': 'hcval_co'})
Expand Down