From b1912607ae9783d6ccf648bd7706a64eca5bedb9 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sat, 12 Mar 2022 10:18:08 +0100 Subject: [mod] replace /help by /info pages and include pages in project docs This patch implements a bolierplate to share content from info-pages of the SearXNG instance (URL /info) with the project documentation (path /docs/user). The info pages are using Markdown (CommonMark), to include them in the project documentation (reST) the myst-parser [1] is used in the Sphinx-doc build chain. If base_url is known (defined in settings.yml) links to the instance are also inserted into the project documentation:: searxng_extra/docs_prebuild [1] https://www.sphinx-doc.org/en/master/usage/markdown.html Signed-off-by: Markus Heiser --- requirements-dev.txt | 1 + 1 file changed, 1 insertion(+) (limited to 'requirements-dev.txt') diff --git a/requirements-dev.txt b/requirements-dev.txt index 7460caf78..6b4efa2f8 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -14,6 +14,7 @@ sphinx-jinja==1.4.0 sphinx-tabs==3.2.0 sphinxcontrib-programoutput==0.17 sphinx-autobuild==2021.3.14 +myst-parser==0.17.0 linuxdoc==20211220 aiounittest==1.4.1 yamllint==1.26.3 -- cgit v1.2.3 From 8751940169378d89a3151df57a40d6ada21f035c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sat, 12 Mar 2022 10:54:30 +0100 Subject: [interim fix] of sphinx-tabs and sphinx-jinja The myst-parser requires >= docutils v.0.17 what ends in a dependency hell where plugins sphinx-tabs and sphinx-jinja we use are involved. This patch can be reverted when [2], [3], [4] are solved and new release is available / see [1]. [1] https://github.com/searxng/searxng/pull/954 [2] https://github.com/executablebooks/sphinx-tabs/issues/152 [3] https://github.com/executablebooks/sphinx-tabs/pull/153 [4] https://github.com/executablebooks/sphinx-tabs/pull/154 Signed-off-by: Markus Heiser --- requirements-dev.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'requirements-dev.txt') diff --git a/requirements-dev.txt b/requirements-dev.txt index 6b4efa2f8..15e3ad3cc 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -10,8 +10,8 @@ twine==3.8.0 Pallets-Sphinx-Themes==2.0.2 Sphinx==4.4.0 sphinx-issues==3.0.1 -sphinx-jinja==1.4.0 -sphinx-tabs==3.2.0 +sphinx-jinja==2.0.1 +sphinx-tabs @ git+https://github.com/return42/sphinx-tabs.git@fix-152#egg=fix-152 sphinxcontrib-programoutput==0.17 sphinx-autobuild==2021.3.14 myst-parser==0.17.0 -- cgit v1.2.3