Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 2.19 KB

README.md

File metadata and controls

57 lines (36 loc) · 2.19 KB
Raw

furo-sphinx-search - Search as you type for Read the Docs

image

This repository is a fork of readthedocs-sphinx-search, and is currently modded for use in python-telegram-bot.

Modded features

  • Made the theme consistent with Furo. It works with both light and dark mode.
  • The theme is now more "material", with rounded corners and cards as results, along with tiny fixes.
  • Included the ability to perform an advanced search - Search by attributes, class, methods, parameters (requires sphinx-paramlinks, if you don't have this, the search filter for that just won't have any effect.), and general documentation.
  • The rtd_search parameter was removed, so no more pushing to history and a better UX.

Note that Advanced Search will work for pure python documentation. If you support for other domains than the python one, feel free to open an issue or a PR.

Installation

This package is not available via pip, so you'll have to install it manually via tags:

pip install git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1

or in your requirements.txt:

git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1

The rest of the configuration process remains the same as the original package. Please refer to the original documentation.

Versioning

This fork follows a modified version of semantic versioning as follows: <upstream version>.<fork version> e.g. 0.2.0.3, this is done so that changes to this fork is easily recognizable while at the same time knowing which version this fork is based on.

Credits

License

This project is licensed under the terms of the MIT license (required to be same as upstream license).