question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

ENH: Support for unified website when multiple sphinx outputs (html, pdf) are required

See original GitHub issue

Is your feature request related to a problem? Please describe.

Sphinx typically build a target type such as html, latex, pdf via latex etc. from a common source. However websites for books typically need to use a number of these build types such as html and pdf to support a download option. When they are run separately – it is sometimes hard to keep the assets in sync and have up to date pdf builds of the site contents etc.

Describe the solution you’d like

Perhaps we should add a sphinx builder website that integrates the build process for multiple output types and manages the assets into a unified _build target to simply deployments.

For example:

jb build ./ --builder=website

would trigger an html build, then a pdf build and copy all necessary built files into _build/website/.

Describe alternatives you’ve considered

An alternative is we could add a sphinx extension to enable pdf downloads (via sphinx build process) for html builder with a simple option in conf for which pdf engine to use pdfhtml or pdflatex

Just not sure if this should be a builder or an extension for html to add pdf.

Issue Analytics

  • State:open
  • Created 3 years ago
  • Reactions:1
  • Comments:12 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
choldgrafcommented, Jun 3, 2020

@DavidPowell hmm - I wonder if it’s worth opening an issue specifically about single-page PDF printing to track these kinds of usability bugs

1reaction
choldgrafcommented, Jun 2, 2020

I mean, we already use _build for jupyter_execute etc, so I think there’s already precedent for using it as a general build outputs folder

Read more comments on GitHub >

github_iconTop Results From Across the Web

Individual page PDFs through browser print function · Issue #685 ...
... ENH: Support for unified website when multiple sphinx outputs (html, pdf) are required #673 refers to the integration of multiple outputs.
Read more >
master PDF - Sphinx Documentation
Sphinx is a documentation generator or a tool that translates a set of plain text source files into various output formats,.
Read more >
Sphinx Documentation - Read the Docs
This is the documentation for the Sphinx documentation builder. Sphinx is a tool that translates a set of reStructuredText3 source files into various...
Read more >
Sphinx Quickstart — Sphinx-RTD-Tutorial documentation
Welcome to the Sphinx 1.7.1 quickstart utility. Please enter values for the following settings (just press Enter to accept a default value, if...
Read more >
Basilisk Release Notes - Hanspeter Schaub
Major enhancement to vizInterface where now multiple spacecraft can be added. ... added a general message to the Sphinx HTML documentation landing page....
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found