Logo

🚀 Tutorials

  • Read the Docs tutorial
  • Getting started with Sphinx
  • Getting started with MkDocs
  • Importing your documentation
  • Configuration file tutorial
  • Example projects

💡 Explanation

  • Choosing between our two platforms
  • Continuous Documentation Deployment
  • Deep dive into Read the Docs

🪄 How-to guides

  • Project setup and configuration
  • Build process
  • Upgrading and maintaining projects
  • Content, themes and SEO
  • Security and access
  • Account management
  • Best practice
  • Troubleshooting problems

📚 Reference

  • Feature reference
    • Custom domains
    • Git provider integrations
    • Versioned documentation
    • Preview documentation from pull requests
    • Build notifications via webhooks and email
    • Custom and built-in redirects on Read the Docs
    • Analytics for search and traffic
    • Private documentation sharing
    • Content Delivery Network (CDN) and caching
    • sitemap.xml support
    • 404 Not Found pages
    • robots.txt support
    • Organizations: permissions for projects and teams
    • Project privacy level
    • Choosing a Single Sign-On (SSO) approach for your organization
    • Automation rules
    • Status badges
    • Canonical URLs
    • Feature flags
    • Flyout menu
    • Environment variables
    • Security logs
    • Server side search
      • Search features
      • Search as you type
    • Single version documentation
    • Documentation in scientific and academic publishing
  • Configuration file v2 (.readthedocs.yaml)
  • Build process overview
  • Build process customization
  • Search query syntax
  • Frequently asked questions
  • Public API
  • Changelog
  • About Read the Docs
  • Developer Documentation
Read the Docs user documentation
  • Feature reference
  • Server side search
  • View page source

Server side search

Read the Docs provides full-text search across all of the pages of all projects, this is powered by Elasticsearch. You can search all projects at https://readthedocs.org/search/, or search only on your project from the Search tab of your project.

See also

Search query syntax

Syntax options for searching Read the Docs projects

Server side search API

Reference to the Server Side Search API

Search features

Read the Docs has the following search features:

Search across subprojects

Subprojects allow you to host multiple discrete projects on a single domain. Every subproject hosted on that same domain is included in the search results of the main project.

Search results land on the exact content you were looking for

We index every heading in the document, allowing you to get search results exactly to the content that you are searching for. Try this out by searching for “full-text search”.

Full control over which results should be listed first

Set a custom rank per page, allowing you to deprecate content, and always show relevant content to your users first. See search.ranking.

Search across projects you have access to

Search across all the projects you access to in your Dashboard. Don’t remember where you found that document the other day? No problem, you can search across them all.

You can also specify what projects you want to search using the project:{name} syntax, for example: “project:docs project:dev search”. See Search query syntax.

Special query syntax for more specific results

We support a full range of search queries. You can see some examples at Special queries.

Configurable

Tweak search results according to your needs using a configuration file.

Ready to use

We override the default search engine of your Sphinx project with ours to provide you with all these benefits within your project. We fallback to the built-in search engine from your project if ours doesn’t return any results, just in case we missed something 😄.

API

Integrate our search as you like. See Server side search API.

Analytics

Know what your users are searching for. See How to use search analytics

Search analytics demo

Search analytics demo. Read more in How to use search analytics.

Search as you type

readthedocs-sphinx-search is a Sphinx extension that integrates your documentation more closely with the search implementation of Read the Docs. It adds a clean and minimal full-page search UI that supports a search as you type feature.

To try this feature, you can press / (forward slash) and start typing or just visit these URLs:

  • https://docs.readthedocs.io/?rtd_search=contributing

  • https://docs.readthedocs.io/?rtd_search=api/v3/projects/

Previous Next

© Copyright Read the Docs, Inc & contributors.

Built with Sphinx using a theme provided by Read the Docs.