Changeset View
Changeset View
Standalone View
Standalone View
docs/index.rst
.. _swh-docs: | .. _swh-docs: | ||||
Software Heritage - Development Documentation | Software Heritage - Development Documentation | ||||
============================================= | ============================================= | ||||
.. toctree:: | |||||
:maxdepth: 2 | |||||
:caption: Contents: | |||||
Getting started | Getting started | ||||
--------------- | --------------- | ||||
* :ref:`getting-started` ← start here to get your own Software Heritage | * :ref:`getting-started` ← start here to get your own Software Heritage | ||||
platform running in less than 5 minutes, or | platform running in less than 5 minutes, or | ||||
* :ref:`developer-setup` ← here to hack on the Software Heritage software | * :ref:`developer-setup` ← here to hack on the Software Heritage software | ||||
stack | stack | ||||
▲ Show 20 Lines • Show All 112 Lines • ▼ Show 20 Lines | |||||
* `URLs index <http-routingtable.html>`_ | * `URLs index <http-routingtable.html>`_ | ||||
* :ref:`search` | * :ref:`search` | ||||
* :ref:`glossary` | * :ref:`glossary` | ||||
.. ensure sphinx does not complain about index files not being included | .. ensure sphinx does not complain about index files not being included | ||||
.. toctree:: | .. toctree:: | ||||
:maxdepth: 2 | |||||
:caption: Contents: | |||||
:titlesonly: | |||||
:hidden: | :hidden: | ||||
:glob: | |||||
architecture | architecture | ||||
getting-started | getting-started | ||||
developer-setup | developer-setup | ||||
manual-setup | manual-setup | ||||
apidoc/modules | API documentation <apidoc/modules> | ||||
swh-*/index | swh.core <swh-core/index> | ||||
swh.dataset <swh-dataset/index> | |||||
swh.deposit <swh-deposit/index> | |||||
swh.graph <swh-graph/index> | |||||
swh.indexer <swh-indexer/index> | |||||
swh.journal <swh-journal/index> | |||||
swh.lister <swh-lister/index> | |||||
swh.loader <swh-loader> | |||||
swh.model <swh-model/index> | |||||
swh.objstorage <swh-objstorage/index> | |||||
swh.scheduler <swh-scheduler/index> | |||||
swh.storage <swh-storage/index> | |||||
swh.vault <swh-vault/index> | |||||
swh.web <swh-web/index> |