Skip to content

docs: add database diagram instructions #1017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: chore: merge changes to main
merged 1 commit into from
Mar 17, 2025
Merged

docs: add database diagram instructions #1017

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/source/pages/developers_guide/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,3 +231,18 @@ some examples.

style_guide
apidoc/index

-----------------------------
Updating the database diagram
-----------------------------

Macaron uses a visual representation of its database to better help developers understand the relationships between the tables within it.
This diagram is created using the `eralchemy2 <https://pypi.org/project/eralchemy2/>`_ an entity relation diagrams generator Python library.
When modifications have been made to Macaron's database, the representative diagram needs to be regenerated to match.
This can be done using the following command:

.. code-block:: bash

eralchemy2 -i 'sqlite:///<path_to_output>/macaron.db' -o er-diagram.svg

Where ``<path_to_output>`` is the location of Macaron's output folder. The resulting diagram can then replace the previous version found at ``docs/source/assets/er-diagram.svg``
Loading