vlorentz authored 2 years ago and Antoine R. Dumont committed 2 years ago

It's no longer built for it.

Document new metrics on outgoing API requests

See merge request swh/devel/swh-docs!274

Document statsd metrics and link to dashboards

See merge request swh/devel/swh-docs!270

Related to T4717

Add the standalone_package_doc sphinx tag when building standalone
documentation of a swh package.

It enables to conditionnally include content in package documentation,
like indices and tables for instance.

Related to T4496

Related to https://gitlab.softwareheritage.org/infra/sysadm-environment/-/issues/4675

Related to https://gitlab.softwareheritage.org/infra/sysadm-environment/-/issues/4674

Django settings modules were no longer filtered out from apidoc
processing when building standalone swh package documentation.

Regression introduced in 2f5cbf0c as tox files use SPHINXOPTS environment
variable to add custom sphinx options (like -W).

Thanks to douardda for noticing.

sphinx-design is an iteration on sphinx-panels and intends to replace
it. It offers more interesting web components like cards which we will
be happy to use for the landing page.

Migration tips are available at:
https://sphinx-design.readthedocs.io/en/rtd-theme/get_started.html#migrating-from-sphinx-panels

Since this got improved using an intermediary build-deps container.

This bootstraps the usual commands related to topics management.

Previously the file patterns that sphinx-apidoc must exclude, stored
in the APIDOC_EXCLUDES variables, were expanded by the shell before
executing the tool resulting in a really long list of files to exclude.
Each time a file was processed by sphinx-apidoc, its path was compared
against that long list of files which was significantly slowing down
the apidoc generation process.

So ensure file exclude patterns are quoted to avoid shell expansion
and greatly speedup sphinx-apidoc execution.

Such files are not of interest for API documentation and can generate doc
build errors.

Since swh-web tests reorganization, we now have such file so we need to
exclude it from apidoc processing.

Related to infra/sysadm-environment#4669

Related to infra/sysadm-environment#4647

- pre-commit from 4.1.0 to 4.3.0,
- codespell from 2.2.1 to 2.2.2,
- black from 22.3.0 to 22.10.0 and
- flake8 from 4.0.1 to 5.0.4. Also freeze flake8 dependencies.

Also change flake8's repo config to github (the gitlab mirror
being outdated).

Those are not really useful as links to source codes are already
present and are out of scope for a user documentation.