latex_elements configuration in openstackdocstheme looks ignored

Bug #1843527 reported by Akihiro Motoki on 2019-09-11
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-doc-tools
Medium
Stephen Finucane

Bug Description

When building the PDF docs as Train community goal, I noticed that latex_elements config from openstackdocstheme [1] is not used even when no latex_elements is configured in doc/source/conf.py.

An example is the i18n repo [2]). The generated PDF file is like [3] and it does not contain the OpenStack logo.

When I copied latex_elements configuration in openstackdocstheme to doc/source/conf.py in the i18n repo [4], I can see the OpenStack logo in the job result of [4].

Note that it seems that latex_engine configured in openstackdocstheme is used expectedly. The default value of latex_engine is "pdflatex" in Sphinx [5] and openstackdocstheme PDF support requires "xelatex", but I don't need to configure "latex_engine" in doc/source/conf.py, so I guess latex_engine is properly configured.

[1] https://github.com/openstack/openstackdocstheme/blob/7aaba6f9f571f13ab3d91afb4afb5c3edf6d4f5b/openstackdocstheme/ext.py#L309-L317
[2] https://github.com/openstack/i18n/blob/077f743444eef84be27f06f2415caad80fa67a0c/doc/source/conf.py#L206-L212
[3] https://docs.openstack.org/i18n/latest/doc-i18n.pdf
[4] https://review.opendev.org/681373
[5] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-latex_engine

Changed in openstack-doc-tools:
status: New → Confirmed
Changed in openstack-doc-tools:
importance: Undecided → Medium
assignee: nobody → Stephen Finucane (stephenfinucane)

Fix proposed to branch: master
Review: https://review.opendev.org/682683

Changed in openstack-doc-tools:
status: Confirmed → In Progress
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers