<div dir="ltr">~ Update ~<div><br></div><div>I've managed to build a PDF locally using a tox target:</div><div><br></div><div>$ tox -e deploy-guide-pdf<br></div><div>deploy-guide/build/pdf/DeploymentGuide.pdf<br></div><div><br></div><div>For my local web server, the resulting HTML has an icon with this download link:</div><div>http://<domain>//doc-charm-deployment-guide.pdf<br></div><div><br></div><div>Which doesn't work.</div><div><br></div><div>How do I fix that? And especially, how do I get Zuul to do it?</div><div><br></div><div>My PR is here:</div><div><br></div><div><a href="https://review.opendev.org/c/openstack/charm-deployment-guide/+/782581">https://review.opendev.org/c/openstack/charm-deployment-guide/+/782581</a><br></div><div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Mar 4, 2021 at 2:13 PM Michael Johnson <<a href="mailto:johnsomor@gmail.com" target="_blank">johnsomor@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Peter,<br>
<br>
Feel free to message me on IRC (johnsom) if you run into questions<br>
about enabling the PDF docs for your projects. I did the work for<br>
Octavia so might have some answers.<br>
<br>
Michael<br>
<br>
On Thu, Mar 4, 2021 at 12:36 AM Bogdan Dobrelya <<a href="mailto:bdobreli@redhat.com" target="_blank">bdobreli@redhat.com</a>> wrote:<br>
><br>
> On 3/3/21 9:30 PM, Jeremy Stanley wrote:<br>
> > On 2021-03-03 15:05:10 -0500 (-0500), Peter Matulis wrote:<br>
> > [...]<br>
> >> How do I get a download PDF link like what is available in the<br>
> >> published pages of the Nova project? Where is that documented?<br>
><br>
> On each project's documentation page, there is a "Download PDF" button,<br>
> at the top, near to the "Report a Bug".<br>
><br>
> >><br>
> >> In short, yes, I am interested in having downloadable PDFs for the<br>
> >> projects that I maintain:<br>
> >><br>
> >> <a href="https://opendev.org/openstack/charm-guide" rel="noreferrer" target="_blank">https://opendev.org/openstack/charm-guide</a><br>
> >> <a href="https://opendev.org/openstack/charm-deployment-guide" rel="noreferrer" target="_blank">https://opendev.org/openstack/charm-deployment-guide</a><br>
> ><br>
> > The official goal document is still available here:<br>
> ><br>
> > <a href="https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html" rel="noreferrer" target="_blank">https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html</a><br>
> ><br>
> > Some technical detail can also be found in the earlier docs spec:<br>
> ><br>
> > <a href="https://specs.openstack.org/openstack/docs-specs/specs/ocata/build-pdf-from-rst-guides.html" rel="noreferrer" target="_blank">https://specs.openstack.org/openstack/docs-specs/specs/ocata/build-pdf-from-rst-guides.html</a><br>
> ><br>
> > A bit of spelunking in Git history turns up, for example, this<br>
> > change implementing PDF generation for openstack/ironic (you can<br>
> > find plenty more if you hunt):<br>
> ><br>
> > <a href="https://review.opendev.org/680585" rel="noreferrer" target="_blank">https://review.opendev.org/680585</a><br>
> ><br>
> > I expect you would just do something similar to that. If memory<br>
> > serves (it's been a couple years now), each project hit slightly<br>
> > different challenges as no two bodies of documentation are every<br>
> > quite the same. You'll likely have to dig deep occasionally in<br>
> > Sphinx and LaTeX examples to iron things out.<br>
> ><br>
> > One thing which would have been nice as an output of that cycle goal<br>
> > was if the PTI section for documentation was updated with related<br>
> > technical guidance on building PDFs, but it's rather lacking in that<br>
> > department still:<br>
> ><br>
> > <a href="https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation" rel="noreferrer" target="_blank">https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation</a><br>
> ><br>
> > If you can come up with a succinct summary for what's needed, I<br>
> > expect adding it there would be really useful to others too.<br>
> ><br>
><br>
><br>
> --<br>
> Best regards,<br>
> Bogdan Dobrelya,<br>
> Irc #bogdando<br>
><br>
><br>
<br>
</blockquote></div>