Move to custom search plugin by borrowing from Mkdocs and existing plugins

This commit is contained in:
Griatch 2020-05-23 14:59:12 +02:00
parent 2c2a0a72f1
commit 99c0b949f7
31 changed files with 12915 additions and 9 deletions

11
docs/search/README.md Normal file
View file

@ -0,0 +1,11 @@
# Search plugin
This is a search plugin that modifies and combines code from two projects:
- Sphinxcontrib-lunrsearch (https://github.com/rmcgibbo/sphinxcontrib-lunrsearch) - the lunr-index
generation component was reworked to read more than just the api and addded supoort for
using the `lunr` python library to pre-generate the search index.
- Mkdocs lunr search (https://www.mkdocs.org/) - the javascript components with
web-worker support, using the index generated by the above module.
Parsing of the documentation to create the index is custom.