6493c1b125
[dev-env] upgrade Sphinx-doc 7.2.3 and unpin at v7.1.2 on py3.8
...
- Sphinx-doc 7.2.0 drops py3.8 support [1][2]
- last version with py3.8 support is 7.1.2
Many LTS distributions still have py3.8 which EOL is in 2024-10 [3].
To continue to support a development environment on py3.8 the rigid dependency
in the development environment is unpinned in py3.8 / environment markers [4].
To get 7.2.3. work, a fix in sphinx-notfound-page is needed [5][6].
[1] https://github.com/searxng/searxng/pull/2658#issuecomment-1684867270
[2] https://github.com/sphinx-doc/sphinx/issues/11621
[3] https://devguide.python.org/versions/#supported-versions
[4] https://peps.python.org/pep-0508/#environment-markers
[5] https://github.com/readthedocs/sphinx-notfound-page/issues/219
[6] https://github.com/readthedocs/sphinx-notfound-page/issues/219#issuecomment-1694691135
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-08-28 10:25:44 +02:00
eb5bea16ff
[fix] sphinx 5.x: add `nav.contents` everywhere that `div.topic` is used
...
Previously, docutils produced `div.topic` for the contents directive, the latest
version produces `nav.contents`. This means that those tables of contents
change appearance when switching to docutils 0.18 [1][2].
[1] https://github.com/sphinx-doc/sphinx/pull/10535/commits/5806f0a
[2] https://github.com/sphinx-doc/sphinx/issues/10534
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-07-05 17:05:06 +02:00
8751940169
[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 <markus.heiser@darmarit.de>
2022-03-12 14:25:34 +01:00
d22a16bc14
[doc] highlight the current page in the sidebar
2022-01-10 10:48:13 +01:00
188efe53e8
[doc] add global TOC to sidebar
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-12-24 07:05:33 +01:00
27bb55ab07
[brand] SearXNG - docs html_theme = "searxng"
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-11-18 17:33:48 +01:00
e14a660c9a
[fix] sphinx-tabs should not overlap sidebar
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-05-14 17:19:49 +02:00
b6dcf90816
Revert "[fix] sphinx 3.1 CSS issues"
...
This reverts commit 0616684baahttps://github.com/sphinx-doc/sphinx/pull/7878 has been merged into
Spinx-doc (v3.1.2), this patch is no longer needed:
See sphinx-doc project, PR 7838 & 7484 with elementary patch to the basic CSS:
- https://github.com/sphinx-doc/sphinx/issues/7838#issuecomment-646009605
- https://github.com/sphinx-doc/sphinx/pull/7484#issuecomment-646058972
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-27 11:27:42 +01:00
0616684baa
[fix] sphinx 3.1 CSS issues
...
See sphinx-doc project, PR 7838 & 7484 with elementary patch to the basic CSS:
- https://github.com/sphinx-doc/sphinx/issues/7838#issuecomment-646009605
- https://github.com/sphinx-doc/sphinx/pull/7484#issuecomment-646058972
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-06-18 19:02:22 +02:00
d07119ca49
docs(css): render ..content and ..toctree directive same
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-02-04 16:43:07 +01:00
b91e07bbf1
docs(css): render HTML rst-example slightly more discreet
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-28 01:26:24 +01:00
31db843c9c
doc: CSS - fix alignment of code block in figure blocks
...
BTW: minor profread of reST.rst
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22 14:08:57 +01:00
5bdca1a5bf
doc: improved HTML table layout (CSS)
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22 11:46:03 +01:00
b82f61f704
doc: reST primer -- describe admonitions & customize their CSS
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-20 11:01:41 +01:00
e1566e68aa
doc: add content to reST primer (WIP) // linuxdoc
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-19 23:36:53 +01:00
bee19a76f7
doc: add reST primer (inital / WIP)
...
preview: https://return42.github.io/searx/dev/reST.html
includes:
- :class: rst-example // admonitions with (rendered) reST markup example
- extlinks to docutils
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-19 17:05:50 +01:00
e4e578e8a9
doc: theme - make sidebar less eye-catching
...
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-13 14:58:13 +01:00
25fa7da6c8
doc: use customized pocoo theme (pallets-sphinx-themes)
...
The old searx theme was a copy of the flask theme. In the meantime this theme
is available from the python module pallets-sphinx-themes.
This patch makes pallets-sphinx-themes as a (dev) requirement and drops most of
the old and obsolete searx theme settings/files.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12 12:21:52 +01:00
20e85275cb
remove Gratipay and Flattr from sidebar
2018-01-23 20:43:22 +01:00
93e6258463
add first blog entry on python3 support
2017-05-13 22:16:23 +02:00
521f398709
disable breaking "searx" into multiple lines
2016-07-09 23:01:00 +02:00
1d6597b407
[enh] initial structure
2015-11-17 23:38:22 +01:00
Markus Heiser