assume-framework / assume

ASSUME - Agent-based Simulation for Studying and Understanding Market Evolution
https://assume.readthedocs.io
20 stars 5 forks source link

create docs as pdf using lualatex #348

Closed maurerle closed 2 months ago

maurerle commented 2 months ago

If you have lualatex and inkscape (for svg to pdf conversion) installed, you can create a pdf handbook version of the ASSUME documentation using:

make -C docs latexpdf

I don't think this will ever be printed, therefore the HTML version is probably much easier to use, though I tinkered with Sphinx last weekend and want to have this config in main too.

The current documentation for Assume 0.3.7 from this PR looks like this: assume.pdf

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 78.11%. Comparing base (35325cd) to head (1de88d1). Report is 1 commits behind head on main.

:exclamation: Current head 1de88d1 differs from pull request most recent head 63c70cf. Consider uploading reports for the commit 63c70cf to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #348 +/- ## ======================================= Coverage 78.11% 78.11% ======================================= Files 43 43 Lines 5068 5068 ======================================= Hits 3959 3959 Misses 1109 1109 ``` | [Flag](https://app.codecov.io/gh/assume-framework/assume/pull/348/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | Coverage Δ | | |---|---|---| | [pytest](https://app.codecov.io/gh/assume-framework/assume/pull/348/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework) | `78.11% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=assume-framework#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.