to prevent weird race condition when both requirements-swh.txt and
requirements-swh-dev.txt are added as requirements.

This is needed to make:

  tox -e sphinx-dev

work as expected, ie. with swh packages installed from sources rather than
from pypi.

This will allow the CI to run the building job with sphinx options like
`-W` (aka "turn warnings into errors").

this aims at eliminating a warning generated by sphinx-build on swh-web's
index, due to the presence of an explicit link to the http-routingtable.html
file (which does not exists at that time, thus generated a warning).

This should be killed once

  https://github.com/sphinx-contrib/httpdomain/pull/19

is accepted and released.

and add swh-storage[listener] dep for the sake of completeness while
building the doc.

the env var setup and django.setup() needs to be done only once.

so we have more than just the 's' index entry 's' in there.

that builds the doc using source code repos located one directory above
instead of published versions of swh subpackages.

Related to T1330.

- back to assets only building in each package
- run sphinx-autodoc on the whole swh package at once

we do not really need a local standalone buildable sphinx project in each swh
subpackage, so running a full 'make html' in each of them is not required any
more.

Since we want to build the doc at once instead of building each swh subpackage
independantly, we need to run apidoc on the whole swh package.

This is done by actually running the apidoc on the pip installed swh
packages instead of the source repositories, since sphinx-apidoc does
not seem to support multiple MODULE_PATH as cmdline argument.

So it's best to use tox to build the doc.

Related to T1330.

so that we can have some generic substitutions which can be used consistently
in the doc.

even though there is no test in this package.

It breaks the index generation in each swh-* package.

and thus prevent sphinx from complaining about rst files not being included in
a toctree without having to insert :orphan: everywhere.

so we do not build each swh-* twice with unavaoidable sphinx wrnings when
building each repo locally.

see D538 in which this swh-db-init command is added.

Closes T1264

Reviewers: anlambert, ardumont

Differential Revision: https://forge.softwareheritage.org/D458

Related P302

This document is supposed to be just the bare minimum to have a working
local swh-environment. Users shouldn't need any information about
advanced PostgreSQL setup and should just use the easiest auth method
(peer authentication).

Antoine Pietri authored 6 years ago and Stefano Zacchiroli committed 6 years ago

Reviewers: zack

Subscribers: zack

Differential Revision: https://forge.softwareheritage.org/D430

As a consequence of rDWAPPSb06167c8ab05