diff --git a/docs/Makefile b/docs/Makefile index c30c50ab..b97c7532 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1 +1,2 @@ include ../../swh-docs/Makefile.sphinx +-include Makefile.local diff --git a/docs/Makefile.local b/docs/Makefile.local new file mode 100644 index 00000000..c186862b --- /dev/null +++ b/docs/Makefile.local @@ -0,0 +1,9 @@ +sphinx/html: sql-autodoc +sql-autodoc: + make -C ../sql/ doc + +.PHONY: sql-autodoc + +# Local Variables: +# mode: makefile +# End: diff --git a/docs/images/db-schema.svg b/docs/images/db-schema.svg new file mode 120000 index 00000000..ea3cdba3 --- /dev/null +++ b/docs/images/db-schema.svg @@ -0,0 +1 @@ +../../sql/autodoc/swh.svg \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 90eee8f9..d75b988b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,20 +1,26 @@ Software Heritage - Development Documentation ============================================= .. toctree:: :maxdepth: 2 :caption: Contents: +High-level storage +------------------ + +* :ref:`sql-storage` + + Low-level object storage ------------------------ * :ref:`swh-archiver-blueprint` Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` diff --git a/docs/sql-storage.rst b/docs/sql-storage.rst new file mode 100644 index 00000000..5764da08 --- /dev/null +++ b/docs/sql-storage.rst @@ -0,0 +1,14 @@ +.. _sql-storage: + +Software Heritage SQL storage +============================= + +Postgres DB schema +------------------ + +.. _swh-storage-db-schema: +.. figure:: images/db-schema.svg + :width: 1024px + :align: center + + Postgres DB schema of high-level Software Heritage storage (click to zoom).