search

comwes / mkpdfs-mkdocs-plugin

Converts your mkdocs documentation in PDF, to be shared with users
https://comwes.github.io/mkpdfs-mkdocs-plugin
GNU General Public License v3.0
103 stars 36 forks source link

Feature Request: disable generation on serve #48

Open tmeuze opened 3 years ago

tmeuze commented 3 years ago

Hello,

I believe this request is functionally the same as #18 , but I am wondering if there exists, or can be added, an option to disable PDF generation via the mkpdfs section of mkdocs.yml - such as "disable_on_serve"?

Reason being is that, due to issues not caused by this plugin, mkdocs serve fails on Mac M1 (I believe it to be a cairo issue - same error as in #44). I would like to be able to use mkdocs serve without having to disable the plugin every time, but it may also be useful for other users who don't need a PDF generated on every issue of that command.

Thank you for the excellent plugin.

comwes commented 3 years ago

@tmeuze, if you have time can you test if the latest version has this feature? Disabling pdf generation is as simple as SKIP_PDF=1 mkdocs serve. Thanks for your feedback

tmeuze commented 3 years ago

Hi, thanks for your response. Sorry, I didn't realize #18 was implemented in that manner already.

I tried SKIP_PDF=1 mkdocs serve verbatim, but still received the cairo errors. I also tried some variations: mkdocs serve SKIP_PDF=1,mkdocs serve -e SKIP_PDF=1. Could you please guide me on how the environmental variable can be used on-demand?

Thank you,

(latest version installed via pip install git+https://github.com/comwes/mkpdfs-mkdocs-plugin)

comwes commented 3 years ago

Being one of those impacted with the flood in Belgium, currently I'm dealing with issue related to insurance and will be able to provide an answer to your question as soon as everything is back to normal on my end. I'll give you an accurate answer as soon as I have few time to test the solution I have in my mind.

KR

tmeuze commented 3 years ago

@comwes Take your time, appreciate your help. I hope everything works out well for you. Stay safe.