OPNsense Forum

English Forums => Documentation and Translation => Topic started by: Greg_E on February 19, 2024, 08:52:50 PM

Title: Compile documentation to epub or pdf?
Post by: Greg_E on February 19, 2024, 08:52:50 PM
Can someone walk me through the steps of compiling the documentation to either an epub or pdf to use with my ereader (or link to the process)? I like to have as many manuals as possible offline just in case I can't get online. I've seen mention on either this forum or reddit about compiling the docs from github into either pdf or epub, but no idea how this is done. epub is actually preferred if it matters.

I'm just getting started with OPNsense, coming from PF.

Thanks.
Title: Re: Compile documentation to epub or pdf?
Post by: lilsense on February 20, 2024, 01:04:02 AM
I think, if you use the link below you can make epub or pdf based on this:
https://docs.readthedocs.io/en/stable/guides/enable-offline-formats.html

https://github.com/opnsense/docs
Title: Re: Compile documentation to epub or pdf?
Post by: Greg_E on February 21, 2024, 04:30:50 PM
I've noticed on other projects that use Read the Docs, there is a direct menu to create PDF/HTML/epub. Would be nice to see the same options for OPNsense to make it easy for us to grab what we need.