From aba3f30b82f79eeaf38705242750dd331be12ac9 Mon Sep 17 00:00:00 2001
From: "Antoine R. Dumont (@ardumont)" <ardumont@softwareheritage.org>
Date: Thu, 25 Mar 2021 10:07:37 +0100
Subject: [PATCH] docs: Update with new modules swh.auth and swh.counters
This also fixes the deposit dependency.
Related to T3172
---
docs/index.rst | 9 +++++++++
requirements-swh-dev.txt | 2 ++
requirements-swh.txt | 4 +++-
3 files changed, 14 insertions(+), 1 deletion(-)
diff --git a/docs/index.rst b/docs/index.rst
index e49bfd7f..bc7b3550 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -52,10 +52,17 @@ Here is brief overview of the most relevant software components in the Software
Heritage stack. Each component name is linked to the development documentation
of the corresponding Python module.
+:ref:`swh.auth <swh-auth>`
+ low-level library used by modules needing keycloak authentication
+
:ref:`swh.core <swh-core>`
low-level utilities and helpers used by almost all other modules in the
stack
+:ref:`swh.counters <swh-counters>`
+ service providing efficient estimates of the number of objects in the SWH archive,
+ using Redis's Hyperloglog
+
:ref:`swh.dataset <swh-dataset>`
public datasets and periodic data dumps of the archive released by Software
Heritage
@@ -178,7 +185,9 @@ Indices and tables
contributing/index
tutorials/index
API documentation <apidoc/modules>
+ swh.auth <swh-auth/index>
swh.core <swh-core/index>
+ swh.counters <swh-counters/index>
swh.dataset <swh-dataset/index>
swh.deposit <swh-deposit/index>
swh.fuse <swh-fuse/index>
diff --git a/requirements-swh-dev.txt b/requirements-swh-dev.txt
index 9fe26ea4..91c3fc33 100644
--- a/requirements-swh-dev.txt
+++ b/requirements-swh-dev.txt
@@ -1,7 +1,9 @@
# Add here internal Software Heritage dependencies, one per line.
# Dependencies need to be ordered in a way that ensure only
# development versions will be used (not the release ones hosted on PyPI).
+../swh-auth[django]
../swh-core[http,db,logging]
+../swh-counters
../swh-model
../swh-journal
../swh-objstorage[testing]
diff --git a/requirements-swh.txt b/requirements-swh.txt
index 6d31e26a..0422e565 100644
--- a/requirements-swh.txt
+++ b/requirements-swh.txt
@@ -1,6 +1,8 @@
# Add here internal Software Heritage dependencies, one per line.
+swh.auth[django]
swh.core[db,http]
-swh.deposit
+swh.counters
+swh.deposit[server]
swh.fuse
swh.graph
swh.indexer
--
GitLab