search

tgingold-cern / cheby

GNU General Public License v3.0
8 stars 4 forks source link

Latex #5

Closed stefanlippuner closed 1 year ago

stefanlippuner commented 1 year ago

Description

This MR introduces support for generation of Latex documentation. Included changes:

Example for generated files: issue84.zip

Discussion

I was honestly not sure where to put the template file (main.tex). Is the location docs/srcs ok?

I chose the tabularray package for the tables because it has multiple features that are useful here:

  1. Support for dynamic column widths (required to support different page sizes).
  2. Support for multi-page tables (e.g. memory map summary)
  3. Good options to achieve a similar style as the HTML version.

Unfortunately, it seems that PDF generation is quite slow. Thus, I've added an option to disable the nice register drawings to speed it up.

It would have been nice to group the registers somehow (e.g. in the PDF table of contents), but I did not find an easy way to add that.

What do you think?

tgingold-cern commented 1 year ago

Thank you for working on that.

I think it can be merged as it is.

Maybe the handling of main.tex could be improved (in another PR): I think it should be installed with the sources, so that the tool can copy it (maybe on an option) while generating the latex output. Otherwise the user has to deal with that manually.

Tell me if I should merge it now (it is not clear if you want to discuss more before the merge).

stefanlippuner commented 1 year ago

Thanks. From my side it's ok to merge it as is and improve the main.tex in a separte PR.

I don't know too much about the installation process. Would I just need to put it under proto/cheby?

tgingold-cern commented 1 year ago

Yes, I think this is a little bit tricky. As far as I know, you indeed need to move it under proto/cheby. Then you have to tell setup.py that this file must be copied.

For another project, I have looked at that and it wasn't so simple. If I remember correctly, there are many way to do it!

Tristan.

From: stefanlippuner @.> Sent: Tuesday, July 4, 2023 9:28 AM To: tgingold-cern/cheby @.> Cc: Tristan Gingold @.>; Comment @.> Subject: Re: [tgingold-cern/cheby] Latex (PR #5)

Thanks. From my side it's ok to merge it as is and improve the main.tex in a separte PR.

I don't know too much about the installation process. Would I just need to put it under proto/cheby?

— Reply to this email directly, view it on GitHubhttps://github.com/tgingold-cern/cheby/pull/5#issuecomment-1619670964, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AL3BNYZ7KMPHPWCPO67KQJTXOPAZVANCNFSM6AAAAAAZ5JE6XQ. You are receiving this because you commented.Message ID: @.***>