Added PDF and ePub download option for RTD documentation as requested in https://github.com/nexB/aboutcode/pull/127 #76
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AyanSinhaMahapatra
requested changes
May 25, 2023
Member
AyanSinhaMahapatra
left a comment
AyanSinhaMahapatra
left a comment
There was a problem hiding this comment.
Thanks, see comments above.
Contributor
Author
|
Hi @AyanSinhaMahapatra , I squashed the commit into one commit. Please check and let me know if this is okay. |
Member
|
@arijitde92 looks good, thanks++ |
Made changes in the .readthedocs.yaml to enable format for downloading pdf and epub versions of the documentation and added latex_elements in the conf.py file which generates the pdf without blank pages. The minimum version requirement for sphinx was 6.2.1 which was causing build failure in read the docs, hence changing it 3.3.1 as written in setup.cfg of nexB/aboutcode Signed-off-by: Arijit De <[email protected]>
Contributor
Author
|
I amended it. I hope this is enough for the merge. If anything else is required, please let me know. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Made changes in the .readthedocs.yaml to enable format for downloading pdf and epub versions of the documentation.
Also made changes in the docs/conf.py to make the generated pdfs without blank pages.
Implemented same fix as done in this issue which was merged in this PR.
I have added pdf and epub options in the .readthedocs.yaml file and have tested the documentation in readthedocs. The pdf and epub versions of the documentation can now be downloaded.
You can check the generated RTD pdf from my forked repository here
@AyanSinhaMahapatra please check and let me know if any other changes are required in this PR.
Tasks
Run tests locally to check for errors.
Signed-off-by: Arijit De [email protected]