From 40fefbe68a8db9865117dddb5e69c1cae7b31545 Mon Sep 17 00:00:00 2001
From: Valentin Lorentz <vlorentz@softwareheritage.org>
Date: Tue, 22 Dec 2020 16:42:20 +0100
Subject: [PATCH] Reference swh-search documentation
---
docs/index.rst | 4 ++++
requirements-swh.txt | 1 +
swh/docs/sphinx/conf.py | 2 +-
3 files changed, 6 insertions(+), 1 deletion(-)
diff --git a/docs/index.rst b/docs/index.rst
index eeeb42d1..b78fea56 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -91,6 +91,9 @@ swh.docs
listing a forge, loading new stuff from a Git repository) and one-off
activities (e.g., loading a specific version of a source package)
+:ref:`swh.search <swh-search>`
+ search engine for the archive
+
:ref:`swh.storage <swh-storage>`
abstraction layer over the archive, allowing to access all stored source
code artifacts as well as their metadata
@@ -164,6 +167,7 @@ Indices and tables
swh.objstorage <swh-objstorage/index>
swh.scanner <swh-scanner/index>
swh.scheduler <swh-scheduler/index>
+ swh.search <swh-search/index>
swh.storage <swh-storage/index>
swh.vault <swh-vault/index>
swh.web <swh-web/index>
diff --git a/requirements-swh.txt b/requirements-swh.txt
index 1c7cad05..6d31e26a 100644
--- a/requirements-swh.txt
+++ b/requirements-swh.txt
@@ -15,6 +15,7 @@ swh.objstorage[testing]
swh.objstorage.replayer
swh.scanner
swh.scheduler
+swh.search
swh.storage[schemata]
swh.vault
swh.web
diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py
index f7555a29..50e02713 100755
--- a/swh/docs/sphinx/conf.py
+++ b/swh/docs/sphinx/conf.py
@@ -70,7 +70,7 @@ language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ["_build", "swh-icinga-plugins/index.rst", "swh-search/index.rst"]
+exclude_patterns = ["_build", "swh-icinga-plugins/index.rst"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
--
GitLab