search

canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 37 forks source link

Adds default configuration for PDF generation #264

Closed SecondSkoll closed 1 month ago

SecondSkoll commented 1 month ago

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 commented 1 month ago

@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.

ru-fu commented 1 month ago

@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 commented 1 month ago

@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.