OPNsense
  • Home
  • Help
  • Search
  • Login
  • Register

  • OPNsense Forum »
  • English Forums »
  • Documentation and Translation (Moderator: fabian) »
  • Wiki & Documentation with Sphinx/Read the Docs: Download as PDF, EPUB, etc.
« previous next »
  • Print
Pages: [1]

Author Topic: Wiki & Documentation with Sphinx/Read the Docs: Download as PDF, EPUB, etc.  (Read 2583 times)

temporaryuser

  • Newbie
  • *
  • Posts: 38
  • Karma: 6
    • View Profile
Wiki & Documentation with Sphinx/Read the Docs: Download as PDF, EPUB, etc.
« on: March 07, 2016, 04:01:38 pm »
Hi there!

Thank you very much for providing such a beautiful documentation using Sphinx with the "Read the Docs" theme.

One of the great features of Sphinx is: "Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text".

Unfortunately I have not found the option for that in your documentation. Did you disable that feature in purpose, or is there any possibility for you implementing it / turning it on? It is very convenient for reading the documentation as EPUB on a tablet or to print it out as PDF.

Thank you & all the best for your young project!

Yours,
temporaryuser
Logged

jschellevis

  • Administrator
  • Full Member
  • *****
  • Posts: 153
  • Karma: 37
    • View Profile
Re: Wiki & Documentation with Sphinx/Read the Docs: Download as PDF, EPUB, etc.
« Reply #1 on: March 08, 2016, 11:56:31 am »
Hi temporaryuser,

Thanks for your compliment!

Currently we don't offer the option to download the docs as they change a lot (very frequent updates and new chapters) and some pages don't export very well to different formats.

I would say keep a close eye on the project and you never know your wish might be granted at a later time.

Cheers,

Jos
Logged

temporaryuser

  • Newbie
  • *
  • Posts: 38
  • Karma: 6
    • View Profile
Re: Wiki & Documentation with Sphinx/Read the Docs: Download as PDF, EPUB, etc.
« Reply #2 on: March 08, 2016, 12:28:10 pm »
Hi Jos,

Quote from: jschellevis on March 08, 2016, 11:56:31 am
Thanks for your compliment!

You are welcome :)

Quote from: jschellevis on March 08, 2016, 11:56:31 am
Currently we don't offer the option to download the docs

BTW: For anybody reading this and not knowing what we are talking about - here is an example:
https://virtualenvwrapper-bitbucket.readthedocs.org/en/stable/
-> If you click on the "v:stable" link at the bottom of the menu on the left side, you will get a menu with the export/download options.

Quote from: jschellevis on March 08, 2016, 11:56:31 am
as they change a lot (very frequent updates and new chapters) and some pages don't export very well to different formats.

I see. Nevertheless me as a consumer of this documentation I would prefer having the freedom of the export and then deal with the downsides you mentioned, since I love reading offline / on paper / as EPUB and make notes, etc. Maybe adding a short warning such as "Beware when exporting: Please come back regularly since this documentation is under active and heavy development" would solve the issue?

Quote from: jschellevis on March 08, 2016, 11:56:31 am
I would say keep a close eye on the project and you never know your wish might be granted at a later time.

Yes, of course, I will keep a close eye on the project in any case, since I am very positive about your reasons to fork pfSense, and I will be a happy new user of OPNsense, soon.
But I also keep my fingers crossed that you will grant me the freedom and openness to read the documentation as I prefer, soon, too.. ;-)

Cheers,
temporaryuser
« Last Edit: March 08, 2016, 12:31:01 pm by temporaryuser »
Logged

  • Print
Pages: [1]
« previous next »
  • OPNsense Forum »
  • English Forums »
  • Documentation and Translation (Moderator: fabian) »
  • Wiki & Documentation with Sphinx/Read the Docs: Download as PDF, EPUB, etc.
 

OPNsense is an OSS project © Deciso B.V. 2015 - 2019 All rights reserved
  • SMF 2.0.15 | SMF © 2017, Simple Machines
    Privacy Policy
    | XHTML | RSS | WAP2