zaclys/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng synced 2024-01-01 19:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

[docs] switch sphinx theme from pallets to furo

Browse source 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2021-12-23 09:12:38 +01:00
parent fe751b0ee8
commit 139554989c
2 changed files with 2 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/conf.py
View file

@ -2,8 +2,6 @@
# SPDX-License-Identifier: AGPL-3.0-or-later # SPDX-License-Identifier: AGPL-3.0-or-later
import sys, os import sys, os
from pallets_sphinx_themes import ProjectLink
from searx import get_setting from searx import get_setting
from searx.version import VERSION_STRING, GIT_URL, GIT_BRANCH from searx.version import VERSION_STRING, GIT_URL, GIT_BRANCH
@ -109,7 +107,6 @@ extensions = [
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
"sphinx.ext.autodoc", "sphinx.ext.autodoc",
"sphinx.ext.intersphinx", "sphinx.ext.intersphinx",
"pallets_sphinx_themes",
"sphinx_issues", # https://github.com/sloria/sphinx-issues/blob/master/README.rst "sphinx_issues", # https://github.com/sloria/sphinx-issues/blob/master/README.rst
"sphinxcontrib.jinja", # https://github.com/tardyp/sphinx-jinja "sphinxcontrib.jinja", # https://github.com/tardyp/sphinx-jinja
"sphinxcontrib.programoutput", # https://github.com/NextThought/sphinxcontrib-programoutput "sphinxcontrib.programoutput", # https://github.com/NextThought/sphinxcontrib-programoutput
@ -135,7 +132,7 @@ issues_github_path = "searxng/searxng"
sys.path.append(os.path.abspath('_themes')) sys.path.append(os.path.abspath('_themes'))
sys.path.insert(0, os.path.abspath("../utils/")) sys.path.insert(0, os.path.abspath("../utils/"))
html_theme_path = ['_themes'] html_theme_path = ['_themes']
html_theme = "searxng" html_theme = "furo"
# sphinx.ext.imgmath setup # sphinx.ext.imgmath setup
html_math_renderer = 'imgmath' html_math_renderer = 'imgmath'
@ -143,23 +140,6 @@ imgmath_image_format = 'svg'
imgmath_font_size = 14 imgmath_font_size = 14
# sphinx.ext.imgmath setup END # sphinx.ext.imgmath setup END
html_theme_options = {"index_sidebar_logo": True}
html_context = {"project_links": [] }
html_context["project_links"].append(ProjectLink("Source", GIT_URL + '/tree/' + GIT_BRANCH))
if WIKI_URL:
html_context["project_links"].append(ProjectLink("Wiki", WIKI_URL))
if PUBLIC_INSTANCES:
html_context["project_links"].append(ProjectLink("Public instances", PUBLIC_INSTANCES))
if ISSUE_URL:
html_context["project_links"].append(ProjectLink("Issue Tracker", ISSUE_URL))
if CONTACT_URL:
html_context["project_links"].append(ProjectLink("Contact", CONTACT_URL))
html_sidebars = {
"**": ["project.html", "relations.html", "searchbox.html", "sourcelink.html"],
}
singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
html_logo = "../src/brand/searxng-wordmark.svg" html_logo = "../src/brand/searxng-wordmark.svg"
html_title = "SearXNG Documentation ({})".format(VERSION_STRING) html_title = "SearXNG Documentation ({})".format(VERSION_STRING)
html_show_sourcelink = True html_show_sourcelink = True

2
requirements-dev.txt
View file

@ -6,7 +6,7 @@ pylint==2.12.2
splinter==0.16.0 splinter==0.16.0
selenium==3.141.0 selenium==3.141.0
twine==3.7.1 twine==3.7.1
Pallets-Sphinx-Themes==2.0.2 furo==2021.11.23
Sphinx==4.3.1 Sphinx==4.3.1
sphinx-issues==1.2.0 sphinx-issues==1.2.0
sphinx-jinja==1.2.1 sphinx-jinja==1.2.1