Emmanuel Engelhart
362db1094d
Clear support list of kiwix-serve supported browsers
2024-09-20 21:06:52 +02:00
Aryan Arora
5f69a41259
add ipv6 support & update docs
2024-06-01 14:59:43 +05:30
Veloman Yunkan
027f7d6620
Reinstated the RTD Sphinx Theme for documentation
...
Sometime in 2023 the default theme on Read-the-Docs was changed to
Alabaster. This change enforces the old theme (sphinx_rtd_theme).
2024-03-07 18:53:37 +04:00
Veloman Yunkan
21a145d999
Fixed the copyright date
2024-03-06 21:15:09 +04:00
Veloman Yunkan
be89de2bbe
More conspicuous "ZIM name" links
2024-03-06 21:15:09 +04:00
Veloman Yunkan
433010a900
Clarified handling of naming conflicts
2024-03-06 21:15:09 +04:00
Veloman Yunkan
dd14e02741
Documented a couple of /search API's caveats
2024-03-06 21:15:09 +04:00
Veloman Yunkan
8ea12b2ce5
Fixed the "book name"-vs-"ZIM name" bug in docs
2024-03-06 21:15:09 +04:00
Veloman Yunkan
d398ebdb3e
Added missing information about /search endpoint
2023-02-11 12:04:18 +01:00
Veloman Yunkan
6ab6abc6d3
Noted the HTTP API type (public/private) in the docs
2023-02-11 11:20:32 +01:00
Veloman Yunkan
eac5898ca8
Doc update for /catalog/v2/entries?count=0
2023-02-10 19:33:10 +01:00
Veloman Yunkan
07bc21754b
Fixed & elaborated documentation of catalog pagination
2023-02-10 16:46:14 +01:00
Veloman Yunkan
996ea031fc
Documented the /search endpoint
2023-01-04 19:43:20 +04:00
Veloman Yunkan
7179244c47
Documented the /raw endpoint
2023-01-04 19:43:20 +04:00
Veloman Yunkan
68d3c9d81d
Documented the /suggest endpoint
2023-01-04 19:43:20 +04:00
Veloman Yunkan
7f86317537
Documented the /catch/external endpoint
2023-01-04 19:43:20 +04:00
Veloman Yunkan
436f1b83f6
Documented library reloading via SIGHUP
2023-01-04 19:43:20 +04:00
Veloman Yunkan
490ba0f3f2
Documented the OPDS API
2023-01-04 19:43:20 +04:00
Veloman Yunkan
591a347647
Added glossary to kiwix-serve's documentation
2023-01-04 19:43:20 +04:00
Veloman Yunkan
ecf5e67759
Documented the --library option
2023-01-04 19:43:20 +04:00
Veloman Yunkan
ec2effe257
Cross-referenced a few options
2023-01-04 19:43:20 +04:00
Veloman Yunkan
244009f3b1
Marked options with directives
...
This will enable cross-referencing them.
2023-01-04 19:43:20 +04:00
Veloman Yunkan
11ef036174
Documented the /random endpoint
2023-01-04 19:43:20 +04:00
Veloman Yunkan
7b5b0cd7f7
Documented the /skin endpoint
2023-01-04 19:43:20 +04:00
Veloman Yunkan
2aef2d4a92
Expanded the /catalog endpoint
2023-01-04 19:43:20 +04:00
Veloman Yunkan
76023e9231
Started documenting kiwix-serve HTTP API
2023-01-04 19:43:20 +04:00
Veloman Yunkan
614f15913f
Added introduction to kiwix-serve's documentation
2023-01-04 19:43:20 +04:00
Veloman Yunkan
6957a8cb1e
Enter docs/
...
This commit introduces an embryo of sphinx-based documentation. The
content of documentation in this commit is limited to the command line
options of kiwix-serve.
2023-01-04 19:43:20 +04:00