diff --git a/docs/architecture/mirror.rst b/docs/architecture/mirror.rst --- a/docs/architecture/mirror.rst +++ b/docs/architecture/mirror.rst @@ -36,7 +36,7 @@ deployment using the |swh| software stack. -.. thumbnail:: images/mirror-architecture.svg +.. thumbnail:: ../images/mirror-architecture.svg General view of the |swh| mirroring architecture. @@ -74,7 +74,7 @@ A more useful mirror can be set up using the :ref:`storage ` component with the help of the special service named `replayer` provided by the -:doc:`apidoc/swh.storage.replay` module. +:mod:`swh.storage.replay` module. .. TODO: replace this previous link by a link to the 'swh storage replay' command once available, and ideally once @@ -110,9 +110,9 @@ - an object storage solution (can be cloud-based or on local filesystem like ZFS pools), - the :ref:`swh-objstorage` component, -- the :ref:`swh.storage.replay` service (part of the :ref:`swh-storage` +- the :mod:`swh.storage.replay` service (part of the :ref:`swh-storage` package) -- the :ref:`swh.objstorage.replayer.replay` service (from the +- the :mod:`swh.objstorage.replayer.replay` service (from the :ref:`swh-objstorage-replayer` package). A `docker-swarm `_ based deployment diff --git a/docs/architecture/overview.rst b/docs/architecture/overview.rst --- a/docs/architecture/overview.rst +++ b/docs/architecture/overview.rst @@ -63,7 +63,7 @@ when a new forge needs to be archived. This example depicts the case of a gitlab_ forge, but any other supported source type would be very similar. -.. thumbnail:: images/tasks-lister.svg +.. thumbnail:: ../images/tasks-lister.svg As one might observe in this diagram, it does two things: @@ -94,7 +94,7 @@ of a repository. Once again, we take the example of a git repository, but any other type of repository would be very similar. -.. thumbnail:: images/tasks-git-loader.svg +.. thumbnail:: ../images/tasks-git-loader.svg Journal @@ -252,7 +252,7 @@ some places of the |swh| codebase contains tools known as "replayers" and "backfillers", designed to keep them in sync: -* the :ref:`Object Storage Replayer ` copies the content +* the :mod:`Object Storage Replayer ` copies the content of an objects storage to another one. It first performs a full copy, then streams new objects using the Journal to stay up to date * the Storage Replayer loads the entire content of the Journal into a Storage database, diff --git a/docs/archive-changelog.rst b/docs/archive-changelog.rst --- a/docs/archive-changelog.rst +++ b/docs/archive-changelog.rst @@ -25,7 +25,7 @@ * **2020-06-11:** completed integration with the IPOL_ journal, allowing paper authors to explicitly deposit_ source code to the archive (`announcement - `_) + `__) * **2020-05-25:** completed first archival of, and added to regular crawling NixOS_ (tracking: `T2411 `_) @@ -61,7 +61,7 @@ * **2019-01-10:** enabled the `save code now`_ service, allowing users to explicitly request archival of a specific source code repository (`announcement - `_) + `__) 2018 @@ -69,11 +69,11 @@ * **2018-10-10:** completed first archival of PyPI_ packages and added PyPI as a regularly crawled package repository (`announcement - `_) + `__) * **2018-09-25:** completed integration with HAL_, allowing paper authors to explicitly deposit_ source code to the archive (`announcement - `_) + `__) * **2018-08-31:** completed first archival of public GitLab_ repositories from `gitlab.com `_ and added it as a regularly crawled forge @@ -84,7 +84,7 @@ * **2018-02-20:** completed archival of Debian_ packages and added Debian as a regularly crawled distribution (`announcement - `_) + `__) 2017 diff --git a/docs/contributing/code-review.rst b/docs/contributing/code-review.rst --- a/docs/contributing/code-review.rst +++ b/docs/contributing/code-review.rst @@ -35,9 +35,9 @@ Good reads on various angles of code review: -* `Best practices `_ (Palantir) ← comprehensive and recommended read, especially if you're short on time -* `Best practices `_ (Thoughtbot) -* `Best practices `_ (Smart Bear) +* `Best practices (Palantir) `_ ← comprehensive and recommended read, especially if you're short on time +* `Best practices (Thoughtbot) `_ +* `Best practices (Smart Bear) `_ * `Review checklist `_ (Code Project) * `Motivation: code quality `_ (Coding Horror) * `Motivation: team culture `_ (Google & FullStory) diff --git a/docs/journal.rst b/docs/journal.rst --- a/docs/journal.rst +++ b/docs/journal.rst @@ -65,7 +65,7 @@ - `swh.journal.objects.privileged_revision `_ - `swh.journal.objects.directory`_ - `swh.journal.objects.content`_ -- `swh.journal.objects.skippedcontent`_ +- `swh.journal.objects.skipped_content`_ - `swh.journal.objects.metadata_authority`_ - `swh.journal.objects.metadata_fetcher`_ - `swh.journal.objects.raw_extrinsic_metadata`_ diff --git a/requirements-swh-dev.txt b/requirements-swh-dev.txt --- a/requirements-swh-dev.txt +++ b/requirements-swh-dev.txt @@ -12,7 +12,7 @@ ../swh-objstorage[testing] ../swh-storage ../swh-objstorage-replayer -../swh-scheduler +../swh-scheduler[simulator] ../swh-deposit ../swh-graph ../swh-icinga-plugins diff --git a/requirements-swh.txt b/requirements-swh.txt --- a/requirements-swh.txt +++ b/requirements-swh.txt @@ -16,7 +16,7 @@ swh.objstorage[testing] swh.objstorage.replayer swh.scanner -swh.scheduler +swh.scheduler[simulator] swh.search swh.storage swh.vault diff --git a/requirements.txt b/requirements.txt --- a/requirements.txt +++ b/requirements.txt @@ -10,3 +10,4 @@ sphinx_rtd_theme sphinx-click myst-parser +sphinx-celery diff --git a/swh/docs/sphinx/conf.py b/swh/docs/sphinx/conf.py --- a/swh/docs/sphinx/conf.py +++ b/swh/docs/sphinx/conf.py @@ -33,6 +33,10 @@ "sphinx.ext.todo", "sphinx_reredirects", "swh.docs.sphinx.view_in_phabricator", + + # swh.scheduler inherits some attribute descriptions from celery that use + # custom crossrefs (eg. :setting:`task_ignore_result`) + "sphinx_celery.setting_crossref", ] # Add any paths that contain templates here, relative to this directory.