ucphhpc / migrid-user-docs

Documentation and user guides for the MiGrid sites at UCPH, including the ERDA and SIF systems
GNU General Public License v3.0
0 stars 0 forks source link

PDF export strategy for user documentation #6

Open aputtu opened 1 year ago

aputtu commented 1 year ago

Ideally, we want simple, topic specific user documentation guides in PDF format, so that we can refer user to these for their convenience.

Sphinx has the option for multiple PDFs, but does Read the Docs? Sphinx allows for export of multiple PDF files from our restructured text. so that we can have:

However, it seems like Read the Docs blocks for Sphinx's build options - and even if a solution exists, it hasn't been put into production: https://github.com/readthedocs/readthedocs.org/issues/2045

We have a few options:

  1. Maintain multiple user documentation guides through multiple Read the Docs projects. Simply use primary PDF export without much configuration. Pro: This will give us the PDF guides needed. Con: complexity in maintenance.
  2. Dive into how to make PDF export work, regardless of Read the Docs. We should be able to create them using the Sphinx configurations. Alternatively, Read the Docs might have a solution already - worth finding out. Pro: Unified editing and maintenance is preferable. Con: Time investigating further. We might need to refer to unofficial sources, and keep track of breaking changes.
  3. Abandon the concept of separate, topic specific PDF guides for the time being. Pro: "It's good enough." Read the Docs offers a responsive design and search functionality. Unified maintenance.
    Con: Users benefiting from a simple, topic specific PDF guide could be overwhelmed by the documentation.

It almost goes without saying, that choosing option 1 will require us to split user documentation sections.

SebastianPrehn commented 1 year ago

Personally,. I prefer solution 2. or 3., where we just convert it into one big PDF and use external tools to separate them into our desired PDFs to offer them elsewhere as an acceptable solution.