Open Stack

On Mon, Jun 24, 2019 at 05:26:08PM +0200, Bogdan Dobrelya wrote:
> On 24.06.2019 12:29, Alexandra Settle wrote:
> > Hi all,
> > 
> > The work for the Train community goal - PDF support for project docs -
> > is well underway. [1] Now, we're looking for volunteers to help test the
> > implementation.
> > 
> > We'll need someone to help build the docs into PDFs and determine things
> > we can fix through tweaks to our docs, or if they're bugs in Sphinx.
> > AKA: We need a troubleshoot artist.
> 
> There seems to be an issue [0] for any projects using the badges [1] or
> other SVGs in their docs. Also the default levels of nesting of the {\begin
> ... \end} stanzas might require additional tunings, like [2]. I'll keep
> posting here on the further issues discovered for PDF doc builds for
> TripleO. Stay tuned :)

The svg in pdf thing was a known issue. When I first looked at building the
nova docs with latex/pdf output a few years ago [1] you had to manually
convert the images before building the latex. Since then sphinx has added
an extension to do this for you:

https://www.sphinx-doc.org/en/master/usage/extensions/imgconverter.html

You should be able to just add that to the extension list in conf.py and it
will convert the svgs at sphinx build time.

-Matt Treinish

[1] https://opendev.org/openstack/nova/commit/62575dd40e5b7698d9ba54641558246489f0614e

> 
> [0] https://github.com/sphinx-doc/sphinx/issues/4720#issuecomment-372046571
> [1] https://governance.openstack.org/tc/badges/
> [2] https://review.opendev.org/667114
> 
> > 
> > If you can volunteer, please add yourself to the wiki table here [2].
> > I've added neutron and nova specifically here as we need someone who is
> > familiar with the project and it's dependencies to help us get that setup.
> > 
> > Any questions? Reach out.
> > 
> > Cheers,
> > 
> > Alex
> > 
> > [1]
> > https://review.opendev.org/#/q/topic:build-pdf-docs+(status:open+OR+status:merged)
> > 
> > [2]
> > https://wiki.openstack.org/wiki/Documentation#PDF_for_Project_Docs_-_Community_Goal
> > 
> 
> 
> -- 
> Best regards,
> Bogdan Dobrelya,
> Irc #bogdando
> 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20190624/e0dd8676/attachment.sig>