diff --git a/docs/admin/index.rst b/docs/admin/index.rst new file mode 100644 index 00000000..f3a99576 --- /dev/null +++ b/docs/admin/index.rst @@ -0,0 +1,11 @@ +=========================== +Administrator documentation +=========================== + +.. toctree:: + :maxdepth: 1 + + installation + api + filtron + morty diff --git a/docs/dev/install/installation.rst b/docs/admin/installation.rst similarity index 100% rename from docs/dev/install/installation.rst rename to docs/admin/installation.rst diff --git a/docs/blog/blog.rst b/docs/blog/index.rst similarity index 100% rename from docs/blog/blog.rst rename to docs/blog/index.rst diff --git a/docs/dev/index.rst b/docs/dev/index.rst new file mode 100644 index 00000000..8e18066c --- /dev/null +++ b/docs/dev/index.rst @@ -0,0 +1,13 @@ +======================= +Developer documentation +======================= + +.. toctree:: + :maxdepth: 1 + + quickstart + contribution_guide + engine_overview + search_api + plugins + translation diff --git a/docs/index.rst b/docs/index.rst index 8fd37cbd..d9503fef 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,4 @@ +================ Welcome to searx ================ @@ -22,37 +23,10 @@ searx can be used over Tor for online anonymity. Get started with searx by using one of the :wiki:`Searx-instances`. If you don't trust anyone, you can set up your own, see :ref:`installation`. - -User documentation ------------------- - .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - user/search_syntax - user/own-instance - -Administrator documentation ---------------------------- - -.. toctree:: - :maxdepth: 1 - - dev/install/installation - admin/api - admin/filtron - admin/morty - blog/blog - -Developer documentation ------------------------ - -.. toctree:: - :maxdepth: 1 - - dev/quickstart - dev/contribution_guide - dev/engine_overview - dev/search_api - dev/plugins - dev/translation + user/index + admin/index + dev/index + blog/index diff --git a/docs/user/index.rst b/docs/user/index.rst new file mode 100644 index 00000000..b13aca21 --- /dev/null +++ b/docs/user/index.rst @@ -0,0 +1,9 @@ +================== +User documentation +================== + +.. toctree:: + :maxdepth: 1 + + search_syntax + own-instance