search

irods / irods_docs

iRODS Documentation
3 stars 17 forks source link

Provide means of generating PDFs of documentation pages #260

Open yr-wang-hit opened 1 month ago

yr-wang-hit commented 1 month ago

irods documentation is very useful in daily operations and maintenance of irods clusters. If there is some way to get offline pdf version for convenience of internal network use.

Thanks.

alanking commented 3 weeks ago

We will not be providing a PDF of the documentation, but we could provide a way to generate the PDFs with mkdocs.

Here is a plugin created for this purpose: https://github.com/zhaoterryy/mkdocs-pdf-export-plugin

I was able to generate PDFs of all the Markdown pages by installing the plugin and configuring it in the mkdocs YAML file. I haven't confirmed that everything is as it should be because it's a LOT of PDFs. Furthermore, I don't think the Doxygen pages are included, so that would be another step.

It's an interesting idea, so I'll leave this open. Unfortunately, I don't have time to dig into this right now. Let us know if you can build the PDFs this way.