Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide means of generating PDFs of documentation pages #260

Open
yr-wang-hit opened this issue May 29, 2024 · 1 comment
Open

Provide means of generating PDFs of documentation pages #260

yr-wang-hit opened this issue May 29, 2024 · 1 comment

Comments

@yr-wang-hit
Copy link

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
Copy link
Contributor

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.

@alanking alanking changed the title pdf offline version of irods doc Provide means of generating PDFs of documentation pages Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants