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 --- docs/src/searx.infopage.rst | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/src/searx.infopage.rst (limited to 'docs/src') diff --git a/docs/src/searx.infopage.rst b/docs/src/searx.infopage.rst new file mode 100644 index 000000000..243e5b0bd --- /dev/null +++ b/docs/src/searx.infopage.rst @@ -0,0 +1,8 @@ +.. _searx.infopage: + +================ +Online ``/info`` +================ + +.. automodule:: searx.infopage + :members: -- cgit v1.2.3