D4778.id16925.diff
No OneTemporary
Actions

Size

1 KB

Subscribers

None

D4778.id16925.diff
View Options

	diff --git a/README.md b/README.md
	--- a/README.md
	+++ b/README.md
	@@ -3,6 +3,12 @@

	Search service for the Software Heritage archive.

	+It is similar to swh-storage in what it contains,
	+but provides different ways to query it: while swh-storage is mostly
	+a key-value store that returns an object from a primary key,
	+swh-search is focused on reverse indices, to allow finding objects that
	+match some criteria; for example full-text search.
	+
	Currently uses ElasticSearch, and provides only origin search (by URL and metadata)

	# Dependencies
	diff --git a/docs/index.rst b/docs/index.rst
	--- a/docs/index.rst
	+++ b/docs/index.rst
	@@ -1,7 +1,15 @@
	-Software Heritage - Python module template
	-==========================================
	+.. _swh-search:

	-Python module template, used as skeleton to create new modules.
	+Software Heritage - search service
	+==================================
	+
	+The SWH search service, or swh-search, stores a partial copy of
	+the \|swh\| archive.
	+It is similar to swh-storage in what it contains,
	+but provides different ways to query it: while swh-storage is mostly
	+a key-value store that returns an object from a primary key,
	+swh-search is focused on reverse indices, to allow finding objects that
	+match some criteria; for example full-text search.


	.. toctree::
	@@ -9,9 +17,10 @@
	:caption: Contents:


	-Indices and tables
	-==================
	+Reference Documentation
	+-----------------------
	+
	+.. toctree::
	+ :maxdepth: 2

	-* :ref:`genindex`
	-* :ref:`modindex`
	-* :ref:`search`
	+ /apidoc/swh.search