Skip to content

[WIP] feature: add sphinx-unified-search #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
AnneCYH wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[WIP] feature: add sphinx-unified-search #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,7 @@
"sphinx_last_updated_by_git",
"sphinx.ext.intersphinx",
"sphinx_sitemap",
"sphinx_unified_search",
]

# Excludes files or directories from processing
Expand Down Expand Up @@ -358,3 +359,19 @@

if "discourse_prefix" not in html_context and "discourse" in html_context:
html_context["discourse_prefix"] = html_context["discourse"] + "/t/"

# sphinx-unified-search configuration
unified_search_projects = [
{
"name": "Landscape",
"base_url": "https://documentation.ubuntu.com/landscape/",
"searchindex_url":
"https://documentation.ubuntu.com/landscape/searchindex.js",
},
{
"name": "Pebble",
"base_url": "https://ubuntu.com/docs/pebble/",
"searchindex_url":
"https://ubuntu.com/docs/pebble/searchindex.js",
},
]
4 changes: 4 additions & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,7 @@ sphinx-sitemap
# Vale dependencies
rst2html
vale

git+https://github.com/canonical/sphinx-unified-search.git@main
#git+ssh://git@github.com/canonical/sphinx-unified-search.git@27f554973f3cd2170586e386709882e2ad98783b
#-e ../../sphinx-unified-search
Loading