docs: add tutorials for running macaron

[tromai]

Close #198 .

[behnazh-w]

I wonder if we should use expected reports that we use for integration tests as examples in docs to ensure they are always up-to-date 🤔

[tromai]

I think it's best to keep the example reports up to date automatically. However, I am thinking how could we tell the Sphinx engine to copy the expected reports to the built directory for the final documentation artifact or whether it would complicate our setup 🤔?

[behnazh-w]

I think it's best to keep the example reports up to date automatically. However, I am thinking how could we tell the Sphinx engine to copy the expected reports to the built directory for the final documentation artifact or whether it would complicate our setup thinking?

We could add relevant tests in integration tests where expected output is read from these example reports to make sure they are always up-to-date. But we should be careful to not add too many tests as the integration tests are already long. We could also modify some of the existing tests to read the expected output from these sample reports.

I'm happy to merge it as it is and track this in a separate issue and PR.

[behnazh-w]

I'm happy to merge it as it is and track this in a separate issue and PR.

Can you please add an issue to keep track of it?