Changeset View
Changeset View
Standalone View
Standalone View
docs/index.rst
.. _swh-docs: | .. _swh-docs: | ||||
Software Heritage - Development Documentation | Software Heritage - Development Documentation | ||||
============================================= | ============================================= | ||||
Getting started | Getting started | ||||
--------------- | --------------- | ||||
* :ref:`getting-started` → deploy a local copy of the Software Heritage | * :ref:`getting-started` → deploy a local copy of the Software Heritage | ||||
software stack in less than 5 minutes, or | software stack in less than 5 minutes, or | ||||
* :ref:`developer-setup` → get a working development setup that allows to hack | * :ref:`developer-setup` → get a working development setup that allows to hack | ||||
on the Software Heritage software stack | on the Software Heritage software stack | ||||
Contributing | |||||
------------ | |||||
* :ref:`patch-submission` → learn how to submit your patches to the | |||||
Software Heritage codebase | |||||
* :ref:`code-review` → rules and guidelines to review code in | |||||
Software Heritage | |||||
* :ref:`python-style-guide` → how to format the Python code you write | |||||
Architecture | Architecture | ||||
------------ | ------------ | ||||
* :ref:`architecture` → get a glimpse of the Software Heritage software | * :ref:`architecture` → get a glimpse of the Software Heritage software | ||||
architecture | architecture | ||||
* :ref:`mirror` → learn what a Software Heritage mirror is and how to set up | * :ref:`mirror` → learn what a Software Heritage mirror is and how to set up | ||||
one | one | ||||
▲ Show 20 Lines • Show All 132 Lines • ▼ Show 20 Lines | .. toctree:: | ||||
:maxdepth: 2 | :maxdepth: 2 | ||||
:caption: Contents: | :caption: Contents: | ||||
:titlesonly: | :titlesonly: | ||||
:hidden: | :hidden: | ||||
architecture | architecture | ||||
getting-started | getting-started | ||||
developer-setup | developer-setup | ||||
contributing/index | |||||
API documentation <apidoc/modules> | API documentation <apidoc/modules> | ||||
swh.core <swh-core/index> | swh.core <swh-core/index> | ||||
swh.dataset <swh-dataset/index> | swh.dataset <swh-dataset/index> | ||||
swh.deposit <swh-deposit/index> | swh.deposit <swh-deposit/index> | ||||
swh.fuse <swh-fuse/index> | swh.fuse <swh-fuse/index> | ||||
swh.graph <swh-graph/index> | swh.graph <swh-graph/index> | ||||
swh.indexer <swh-indexer/index> | swh.indexer <swh-indexer/index> | ||||
swh.journal <swh-journal/index> | swh.journal <swh-journal/index> | ||||
Show All 13 Lines |