diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -35,6 +35,10 @@ low-level utilities and helpers used by almost all other modules in the stack +:ref:`swh.dataset ` + public datasets and periodic data dumps of the archive released by Software + Heritage + :ref:`swh.deposit ` push-based deposit of software artifacts to the archive diff --git a/requirements.txt b/requirements.txt --- a/requirements.txt +++ b/requirements.txt @@ -6,4 +6,5 @@ sphinxcontrib-httpdomain sphinxcontrib-images sphinxcontrib-programoutput +sphinx-tabs recommonmark 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 @@ -22,6 +22,7 @@ 'sphinxcontrib.images', 'sphinxcontrib.programoutput', 'sphinx.ext.viewcode', + 'sphinx_tabs.tabs', ] # Add any paths that contain templates here, relative to this directory. diff --git a/tox.ini b/tox.ini --- a/tox.ini +++ b/tox.ini @@ -10,6 +10,7 @@ django < 2 .[building] pifpaf + sphinx-tabs commands = {envpython} -m pifpaf run postgresql -- make -C docs {posargs:html} @@ -18,6 +19,7 @@ django < 2 -rrequirements-swh-dev.txt pifpaf + sphinx-tabs commands = {envpython} -m pifpaf run postgresql -- make -C docs {posargs:html} @@ -25,5 +27,6 @@ skip_install = true deps = flake8 + sphinx-tabs commands = {envpython} -m flake8