Skip to content

Conversation

jmwright
Copy link
Member

Closes #1352

It should make zipped HTML, PDF and epub formats available for download.

@jmwright jmwright requested review from adam-urbanczyk and removed request for adam-urbanczyk July 19, 2023 13:46
@jmwright
Copy link
Member Author

@adam-urbanczyk @lorenzncode I think this one should be pretty straight forward. Related RTD documentation here and here.

@codecov
Copy link

codecov bot commented Jul 19, 2023

Codecov Report

Merging #1377 (f333d38) into master (da6354f) will not change coverage.
The diff coverage is n/a.

❗ Current head f333d38 differs from pull request most recent head 0110d5f. Consider uploading reports for the commit 0110d5f to get more accurate results

@@           Coverage Diff           @@
##           master    #1377   +/-   ##
=======================================
  Coverage   94.12%   94.12%           
=======================================
  Files          27       27           
  Lines        5671     5671           
  Branches      961      961           
=======================================
  Hits         5338     5338           
  Misses        199      199           
  Partials      134      134           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@adam-urbanczyk adam-urbanczyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, how will a pdf +vtkjs look like though?

@jmwright
Copy link
Member Author

how will a pdf +vtkjs look like though?

I honestly don't know. I thought that RTD might build the artifacts for a PR so that we could check them, but it didn't.

@sethfischer
Copy link
Contributor

From https://docs.readthedocs.io/en/stable/guides/pull-requests.html#limitations

Additional formats like PDF and EPUB aren’t built, to reduce build time.

@sethfischer
Copy link
Contributor

sethfischer commented Jul 21, 2023

I believe the Sphinx directives in cadquery/cq_directive.py will require modification to produce an output suitable for building a PDF. A typical approach would be for the directive to detect that a PDF is being built, and rather than generate VTK JS + HTML, generate a raster image such as PNG.

Copy link
Member

@lorenzncode lorenzncode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps go ahead with this PR and try 'all' to see what it looks like now. Then limit to htmlzip until when/if PDF is better supported.

@jmwright
Copy link
Member Author

Ok, I'll try it. I don't know that any of us have our GitHub accounts linked to RTD (a requirement for enabling PR builds). At least the accounts for Dave and I predate that login option.

@jmwright jmwright merged commit 6b35f59 into master Jul 24, 2023
@jmwright jmwright deleted the rtd_offline branch July 24, 2023 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Offline version of documentation (zipped HTML)

4 participants