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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish PDF version of RTD documentation #125 #127

Merged
merged 2 commits into from
May 22, 2023
Merged

Publish PDF version of RTD documentation #125 #127

merged 2 commits into from
May 22, 2023

Conversation

arijitde92
Copy link
Contributor

Made changes in the .readthedocs.yaml to enable format for downloading pdf and epub versions of the documentation

Fixes #125

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.
As per the screenshot below, the option to download pdf version is shown in the red rectangle.
pdf_screenshot

After clicking on the above link, the pdf document appears in a browser tab as shown below-
pdf_file_screenshot

This fixes issue #125

Let me know if any other changes are required in this PR.

Tasks

  • PR is descriptively titled 馃搼 and links the original issue above 馃敆
  • Tests pass -- look for a green checkbox 鉁旓笍 a few minutes after opening your PR
    Run tests locally to check for errors.
  • Commits are in uniquely-named feature branch and has no merge conflicts 馃搧

Signed-off-by: Arijit De arijitde2050@gmail.com

Made changes in the .readthedocs.yaml to enable format for downloading pdf and epub versions of the documentation

Signed-off-by: Arijit De <arijitde2050@gmail.com>
Added latex_elements in the conf.py file

Signed-off-by: Arijit De <arijitde2050@gmail.com>
Copy link
Member

@AyanSinhaMahapatra AyanSinhaMahapatra left a comment

Choose a reason for hiding this comment

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

@arijitde92 Thanks++
I've reviewed the pdf, epub and the options to download this in the RTD build, looks good to me.
We also need to add this to our skeleton repo: https://github.com/nexB/skeleton, so this is enabled org-wide. Can I also interest you in opening a PR there?
Merging this!

@AyanSinhaMahapatra AyanSinhaMahapatra merged commit 8578923 into nexB:main May 22, 2023
2 checks passed
@arijitde92
Copy link
Contributor Author

Hi @AyanSinhaMahapatra , thanks for merging my commit.
I shall open a PR in the skeleton repo.
Do I need to create a new issue in that repo first before working on the PR? Or shall I directly raise a PR in that repo?

@AyanSinhaMahapatra
Copy link
Member

You can reference this issue and this PR also, no need to create another issue 馃槈

AyanSinhaMahapatra added a commit to nexB/skeleton that referenced this pull request Jun 1, 2023
Added PDF and ePub download option for RTD documentation as requested in nexB/aboutcode#127
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.

Publish PDF version of RTD documentation
2 participants