search

useblocks / sphinx-simplepdf

A simple PDF builder for Sphinx documentations
https://sphinx-simplepdf.readthedocs.io
MIT License
36 stars 15 forks source link

Add debug option - show used Python interpreter and relevant packages on last PDF page #24

Closed 1kastner closed 1 year ago

1kastner commented 1 year ago

Just a feature request - I was struggling to create a PDF in https://github.com/useblocks/sphinx-simplepdf/issues/9 and I want to rule out that the issue is related to a poorly configured environment on my side. Therefore, a debug option would be great. My suggestion is that once the debug option is active, the last page(s) of the PDF shows the used Python interpreter and relevant packages. I do not care about styling, it just needs to be functional. Thanks a lot for the project and your effort!

danwos commented 1 year ago

Good point, I use similar methods also in other projects.

We could add a page, similar to "cover.html", to the theme. It gets included only if `sphinxpdf_debug = True" is set inconf.py`. And it gets its data from 1-2 jinja functions, which are able to collect the needed information.

The realization will need some time on my side, too many other projects at the moment :(

1kastner commented 1 year ago

Reminder to myself: The variable is called simplepdf_debug and works perfectly!