summaryrefslogtreecommitdiff
path: root/searx/user_help.py
AgeCommit message (Collapse)Author
2022-02-01[enh] make searx.user_help use an explicit TOCMartin Fischer
When we have multiple help pages we want them to be displayed in a specific order.
2022-02-01[enh] introduce /help routeMartin Fischer
Translation will be implemented in the future. For now the "en" in /help/en/<pagename> is hardcoded.
2022-02-01[pyright:basic] searx.user_helpMartin Fischer
2022-01-23[help] stop rendering documentation with Jinja2Martin Fischer
To facilitate translation of the user documentation we move the templating logic outside of the user documentation.
2022-01-23[help] convert about.html to MarkdownMartin Fischer
To facilitate translation the new user documentation shall be written in Markdown (which is more human-friendly than HTML and reStructuredText).
2022-01-23[help] render user documentation once on startupMartin Fischer
Currently we have two kinds of user documentation: * the about page[1] which is written in HTML and part of the web application and can therefore link instance-specific pages (like e.g. the preferences) via Jinja variables * the Sphinx documentation[2] which is written in reStructuredText and cannot link instance-specific pages since it doesn't know which instance the user is using The plan is to integrate the user documentation currently in Sphinx into the application, so that it can also link instance specific pages. We also want to enable the user documentation to be translated. This commit implements the first step in this endeavor (see #722). [1]: searx/templates/__common__/about.html [2]: docs/user/ (currently served at https://docs.searxng.org/user/)