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

Adds default configuration for PDF generation #264

Merged
merged 9 commits into from
Aug 8, 2024

Conversation

SecondSkoll
Copy link
Collaborator

Adds files required for PDF generation, including some base images, fonts.
Adds make targets to generate PDFs, including a separate target to install local packages.
Provides configuration for the PDF in custom_conf.
Adds CSS role to allow HTML heading on index without affecting PDF generation due to nesting issue.

@SecondSkoll SecondSkoll requested a review from ru-fu July 25, 2024 03:11
Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

I haven't tested it yet, but overall this looks good!
Some comments about keeping the implementation clean and maintainable.

.sphinx/_static/custom.css Show resolved Hide resolved
.sphinx/fonts/Ubuntu-B.ttf Outdated Show resolved Hide resolved
Makefile.sp Outdated Show resolved Hide resolved
Makefile.sp Outdated Show resolved Hide resolved
Makefile.sp Outdated Show resolved Hide resolved
custom_conf.py Outdated Show resolved Hide resolved
readme.rst Outdated Show resolved Hide resolved
readme.rst Outdated Show resolved Hide resolved
readme.rst Outdated Show resolved Hide resolved
.sphinx/_static/custom.css Show resolved Hide resolved
Makefile.sp Outdated Show resolved Hide resolved
custom_conf.py Outdated Show resolved Hide resolved
Adds template for latex_elements
ru-fu
ru-fu previously requested changes Aug 5, 2024
Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

Blocking because we cannot remove the _build folder (that has our HTML output).

custom_conf.py Outdated Show resolved Hide resolved
Makefile.sp Outdated Show resolved Hide resolved
Makefile.sp Outdated Show resolved Hide resolved
.sphinx/images/front-page.png Outdated Show resolved Hide resolved
readme.rst Outdated Show resolved Hide resolved
@SecondSkoll SecondSkoll requested a review from ru-fu August 7, 2024 03:54
@SecondSkoll SecondSkoll dismissed ru-fu’s stale review August 7, 2024 03:54

Requested changes have been made

Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

A couple more small comments, but overall, this looks good!

Now the next question is - will RTD pick up this PDF build automatically, or does it need some configuration (probably in .readthedocs.yaml)?

Makefile.sp Outdated Show resolved Hide resolved
custom_conf.py Outdated Show resolved Hide resolved
Makefile.sp Outdated Show resolved Hide resolved
Makefile.sp Outdated Show resolved Hide resolved
@SecondSkoll
Copy link
Collaborator Author

@ru-fu As long as the .readthedocs.yaml file has PDF listed under formats - as the Stater Pack does by default - the configuration will be picked up.

Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

Thanks! :)

@ru-fu
Copy link
Contributor

ru-fu commented Aug 8, 2024

@ru-fu As long as the .readthedocs.yaml file has PDF listed under formats - as the Stater Pack does by default - the configuration will be picked up.

Curious how the installation of packages works there ... do they have them installed already? Or where do they get them from?

@SecondSkoll
Copy link
Collaborator Author

@ru-fu I imagine they have set build systems with something like Bamboo, rather than ad-hoc or request driven environments. From the lack of xindy support I assume they don't try to dig through configs or anything super clever.

@SecondSkoll SecondSkoll merged commit 6a0e7b1 into canonical:main Aug 8, 2024
3 checks passed
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.

3 participants