ragas icon indicating copy to clipboard operation
ragas copied to clipboard

Printing documentation to PDF

Open pretty-speeches opened this issue 3 months ago • 6 comments

Describe the Feature An option to print to PDF would help go over all the features of the package.

Why is the feature important for you? Moving through pages makes it hard to return to the right place and understand what was already covered.

pretty-speeches avatar Sep 04 '25 18:09 pretty-speeches

Hey @pretty-speeches 👋🏽

you can use this plugins like

  • https://github.com/adrienbrignon/mkdocs-exporter
  • https://timvink.github.io/mkdocs-print-site-plugin/

to do it but I am doubtful if we should add it as a core functionality. Marking this as good first issue to get more opinions during the Pycon India 25 devsprint

jjmachan avatar Sep 15 '25 01:09 jjmachan

Hey @jjmachan . Looks cool to me. Can I work on it? I don't know pretty much anything about ragas (except that it's written in Python) but I'm confident I can figure something out and get back to you soon.

Sweetdevil144 avatar Oct 26 '25 00:10 Sweetdevil144

@Sweetdevil144 Feel free to take a dig at it.

anistark avatar Oct 26 '25 08:10 anistark

@Sweetdevil144 Did you get a chance to take a dig at this?

anistark avatar Nov 18 '25 09:11 anistark

Hey. Been busy with sems until noe. Taking a look in it now

Sweetdevil144 avatar Nov 22 '25 01:11 Sweetdevil144

@anistark here is what I found :

  • https://github.com/adrienbrignon/mkdocs-exporter : explicitly requires users downloading PDF to have playwright browser compatibility. Let's rule out this Option.
  • https://pypi.org/project/mkdocs-with-pdf/ : Create clean and neat PDFs. However, it uses WeasyPrint which requires users to priorly do 'brew install weasyprint' for WeasyPrint to do its magic. Same issue with https://github.com/zhaoterryy/mkdocs-pdf-export-plugin
  • https://timvink.github.io/mkdocs-print-site-plugin/ : Create a single Page which users need to manually print via 'Ctrl+P' option. Reference : https://github.com/mkdocs/mkdocs/discussions/3912. This seems to be our best option for now.

Let me know if you know of any other alternatives.

Sweetdevil144 avatar Nov 23 '25 05:11 Sweetdevil144