Skip to content

Add LaTeX file and refactor classes

Hugo Buddelmeijer requested to merge hb/feature/addtexfile into develop

This MR does various things (sorry for combining so much, things got kinda intertwined):

  • It adds MicadoWISE_DataModel.tex (and pdf) that includes every generated TeX file. (This was the goal of this branch.) This serves three purposes:
    • We have better documentation in MicadoWISE itself. (Although some work is needed to make the pdf usable).
    • We verify that all the LaTeX that is generated is actually correct LaTeX.
    • We still have a useful LaTeX file after we hand over the DRLD/CP/DRLVT to MPE.
  • It refactor some toolbox scripts. (This helped with making the LaTeX file.) They used to all point to each other. Changes in particular:
    • Addition of util/classlists.py with lists of classes. E.g. which classes to include in which document, which classes belong to which workflow, etc. It would be nicer to have this in the datamodel directly, but it is kinda arbitrary, so it is hard to make good rules for it.
    • util/classlits.py imports aweimports, which fills the classcache, which is then used to create the lists. This changed the order of some lists in the tex files, but the content is the same.
    • Importing aweimports also makes the CI faster, because when common is not available, the mock-common library is used and then it matters in what order the imports are done. (AAARGh.) The order of the imports in aweimports is the fastest.
    • Addition of util/paths.py with Pathlib Path instances that point to various directories.
    • Addition of derivedclasses.py with some helper functions that are used in various places. Should be refactored further at some point.
    • Now most toolbox modules only refer to classlists.py and paths.py and only to each other when this makes sense. (Can still be improved.)

@wjvriend , assigning to you, if you want to review it, the best place to start would be the toolbox directory again.

Edited by Hugo Buddelmeijer

Merge request reports