pgrondek/polybar-dwm
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(doc): Add rtd search extension

Browse Source 
Provides real-time search on readthedocs

Ref: https://readthedocs-sphinx-search.readthedocs.io
This commit is contained in:
patrick96 2023-10-08 21:20:31 +02:00 committed by Patrick Ziegler
parent 19e8d53320
commit 278584fa27
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/conf.py
View File

@ -88,6 +88,11 @@ extensions = [
"sphinx.ext.extlinks", "sphinx.ext.extlinks",
] ]
# The search extension works only on readthedocs
# See https://readthedocs-sphinx-search.readthedocs.io
if on_rtd:
extensions.append("sphinx_search.extension")
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = [doc_path + '/_templates'] templates_path = [doc_path + '/_templates']

1
doc/requirements.txt
View File

@ -1 +1,2 @@
sphinx-rtd-theme~=1.3.0 sphinx-rtd-theme~=1.3.0
readthedocs-sphinx-search~=0.3.1