Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (
Help us improve Python packaging - Donate today!

Decently styled search results for sphinx-doc projects

Project Description

Sphinx: pretty search results

Sphinx: pretty search results is an extension for the Sphinx documentation tool.

To display search results, Sphinx is fetching the source files of search hits and rendering excerpts in raw markup (Example).

This extension removes the markup from these source files (during build time), so the search results look decent.


Run pip install sphinxprettysearchresults.


There are no custom configuration variables for the Sphinx: pretty search results extension.

After installing the extension, all you need to do is to register it.

Add sphinxprettysearchresults to the extensions array in your file, for example:

extensions = [

After your next build, your project will no longer display raw markup in the search result excerpts.


Sphinx: pretty search results uses nose as a test framework.

To run the tests, you first need to install the dev dependencies:

pip install -r pip install -r dev_requirements.txt

Then, navigate to the tests directory and run:

Release History

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxprettysearchresults-0.1.7.tar.gz (3.3 kB) Copy SHA256 Checksum SHA256 Source Oct 3, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting