Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish PDF version of RTD documentation #125

Closed
mjherzog opened this issue Apr 11, 2023 · 4 comments · Fixed by #127
Closed

Publish PDF version of RTD documentation #125

mjherzog opened this issue Apr 11, 2023 · 4 comments · Fixed by #127

Comments

@mjherzog
Copy link
Member

We need a better way to review project documentation to suggest improvements and corrections to our project/product documentation. It is slow and difficult to review doc changes in a PR format.

This page - https://docs.readthedocs.io/en/stable/downloadable-documentation.html - seems to indicate that we could generate a PDF (or ePub or HTML) format document by adding it to a Sphinx-based workflow.

PDF output would be very useful for offline use and it could be a good way to print a review copy that anyone could annotate with a PDF editing tool.

@adityachouh
Copy link

hello, may i work on this one?
can you please assign me .
new in open souce.

@arijitde92
Copy link
Contributor

Hi @mjherzog,
I have fixed the issue and have also raised the PR for the same. #127
Please check the readthedocs documentation for the forked version of the project here
Please let me know if anything needs to be changed.

@mjherzog
Copy link
Member Author

Hello @arijitde92 The PDF and ePubl files look good. There seen to be some "extra" blank pages at the start of the PDF file, but this is minor. Thank you.

@arijitde92
Copy link
Contributor

Hi @mjherzog, I have removed the blank pages. Please check the pdf here.
This commit has the latest updated version where I have added the settings to remove blank page.
I hope the PR can be merged now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants