| *** threestrands has joined #openstack-doc | 00:24 | |
| *** seongsoocho has joined #openstack-doc | 00:34 | |
| *** rcernin has quit IRC | 01:13 | |
| *** factor has joined #openstack-doc | 01:33 | |
| *** rcernin has joined #openstack-doc | 02:13 | |
| *** vishakha has joined #openstack-doc | 05:12 | |
| *** factor has quit IRC | 05:41 | |
| *** miloa has joined #openstack-doc | 05:52 | |
| amotoki | asettle: I just sent a mail to share the current status of the PDF goal. This is what I have now. If you have something to add, please follow it up. | 06:03 |
|---|---|---|
| amotoki | asettle: http://lists.openstack.org/pipermail/openstack-discuss/2019-August/008783.html | 06:03 |
| miloa | Morning | 06:50 |
| ianychoi | amotoki, thank you for sharing the nice summary on current status - so great progress! | 07:31 |
| *** threestrands has quit IRC | 07:32 | |
| amotoki | ianychoi: you're welcome | 07:35 |
| miloa | jrosser and evrardjp: if you can check https://review.opendev.org/#/c/671762/ to tell me if I am going on the right direction. Thanks :) | 07:40 |
| *** rcernin has quit IRC | 07:40 | |
| evrardjp | miloa: wrong chan :) | 07:41 |
| miloa | oups sorry | 07:41 |
| evrardjp | but yeah I will have a look | 07:41 |
| miloa | evrardjp: thanks :) | 07:46 |
| vishakha | Hi amotoki Could you help with keystone patch https://review.opendev.org/#/c/669982. Facing issue https://zuul.opendev.org/t/openstack/build/ec6d51585a3c4b31b42aebe928c73e35/log/job-output.txt#5395 | 07:54 |
| amotoki | vishakha: it looks like the first case we hit. | 08:00 |
| amotoki | vishakha: I don't know how support-matrix.css is used in the keystone doc (so I am not sure it is needed or not) but https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-latex_additional_files might work. | 08:00 |
| amotoki | vishakha: let me note that I will be on vacation since tomorrow :) | 08:01 |
| vishakha | amotoki: thanks for the reply. Yes please you can note down it. Have a great vacation. Enjoy | 08:03 |
| vishakha | amotoki: i wasn’t able to find any clue on this error | 08:04 |
| amotoki | vishakha: the sphinx latex builder usually copies static files referred to by sphinx directives like image, but if you use static files unknown to sphinx you need to specify latex_additional_files to let sphinx know them. | 08:06 |
| amotoki | vishakha: just fyi: nova doc has support matrix stuff in _static dir. it is similar to keystone doc, but I didn't hit your issue when building nova PDF file. | 08:08 |
| vishakha | amotoki: thanks. I understood. I will update it | 08:08 |
| *** alexmcleod has joined #openstack-doc | 08:22 | |
| *** brinzhang_ has quit IRC | 09:32 | |
| *** brinzhang_ has joined #openstack-doc | 09:32 | |
| amotoki | stephenfin: (while it is not a right channel) thank you for your work on horizon django 2.2 support. I will take a look next week when I am back from my travel. | 09:44 |
| stephenfin | amotoki: happy to help | 09:44 |
| vishakha | amotoki: Could you share any usage of latex_additional_files? | 09:45 |
| amotoki | vishakha: do you mean an example? no project uses it so far. | 09:48 |
| amotoki | vishakha: one example is found at https://www.sphinx-doc.org/en/master/latex.html (search by latex_additional_files) | 09:48 |
| vishakha | amotoki: ohh ok. Thanks | 09:48 |
| *** brinzhang_ has quit IRC | 09:49 | |
| *** brinzhang_ has joined #openstack-doc | 09:50 | |
| *** brinzhang_ has quit IRC | 11:09 | |
| *** brinzhang_ has joined #openstack-doc | 11:09 | |
| *** tesseract has joined #openstack-doc | 11:11 | |
| amotoki | AJaeger: asettle: stephenfin: I just found a surprising failure mode in the PDF build which is caused by a project badge SVG file. See the diff between patch set 1 and 2 of https://review.opendev.org/#/c/678779/1..2 | 11:17 |
| AJaeger | We could still rename the PDF build file if that is a common pattern. Or is there a way to rename the badge file? | 11:23 |
| amotoki | Yeah, both are possible options, but we two run out of time.... hopefully asettle can coordinate the solution. | 11:24 |
| amotoki | in case of neutron stadium, a common failure mode of this is where README.rst has a link to a badge and README.rst is included in doc/source/index.rst. | 11:27 |
| amotoki | while networking-ovn case is different, networking-sfc, networking-bagpipe and neutron-dynamic-routing hit this pattern. | 11:28 |
| amotoki | I am not sure how many projects adopt this pattern as OpenStack-wide. | 11:29 |
| AJaeger | there was a mass-change to add the badge to README.rst, and many repos include README, not sure what number | 11:30 |
| amotoki | renaming badge files affects many many repositories as china contributions made almost all README.rst have them.... | 11:30 |
| amotoki | so we have two practical options: (a) to skip badge file for PDF, or (b) rename an expected PDF filename to something (like doc-<repo-name>.pdf) | 11:31 |
| amotoki | one tricky thing on (a) is that gitea/github/PyPI do not understand 'only:: html' directive, so we need to duplicate the contents of README.rst to index.rst.... | 11:33 |
| amotoki | so if we can, (b) looks better to me. | 11:33 |
| amotoki | ah, there is option (c) to skip the beginning of files using :start-line: option of 'include' directive. | 11:35 |
| AJaeger | b is still possible, need updating of https://opendev.org/zuul/zuul-jobs/src/branch/master/roles/fetch-sphinx-tarball/defaults/main.yaml#L5 and the README file for the role. | 11:36 |
| AJaeger | and then updating of all changes currently proposed... | 11:37 |
| AJaeger | feel free to propose a change for zuul-jobs, I can review later but have limited time for patches myself | 11:38 |
| amotoki | yeah, that's possible but if we go to this route, we need to do this soon. Otherwise more projects need to update their latex_documents | 11:38 |
| amotoki | I am going to travel on vacation from tomorrow (12 hours later :)) so I would like to defer it to others :p | 11:39 |
| AJaeger | amotoki: yes, exactly. | 11:39 |
| AJaeger | stephenfin, asettle , please drive this through - both amotoki and myself are away and can only advise on this | 11:39 |
| amotoki | option (d) is to use 6th element of latex_documents (toctree only) which skips README.rst inclusion in the top index.rst. This might be a good option when README.rst introduces sections unnecessary from PDF perspetive. | 11:48 |
| * AJaeger needs to go offline for a bit | 11:50 | |
| *** AJaeger is now known as AJaeger_ | 11:50 | |
| amotoki | AJaeger: thanks for your help. Enjoy your vacation | 11:50 |
| amotoki | option (b) looks more robust solution. option (c) and (d) are just workarounds per project. | 11:51 |
| *** brinzhang_ has quit IRC | 13:12 | |
| *** brinzhang has joined #openstack-doc | 13:14 | |
| *** KeithMnemonic has joined #openstack-doc | 13:14 | |
| openstackgerrit | Ildiko Vancsa proposed openstack/training-guides master: Updating the website for the Shanghai Summit https://review.opendev.org/678826 | 13:16 |
| amotoki | some update: in case of neutron-dynamic-routing repo, toctree_only=True in latex_documents in doc/source/conf.py provides a better document structure. toctree_only=True also allows me to avoid the above issue of filename conflict. I understand this solution does not work for all repos though. | 13:20 |
| *** vishakha has quit IRC | 13:37 | |
| openstackgerrit | Brian Rosmaita proposed openstack/openstack-manuals master: Update formats page in VM Image Guide https://review.opendev.org/678856 | 14:15 |
| *** jamesmcarthur has joined #openstack-doc | 15:05 | |
| *** alexmcleod has quit IRC | 15:07 | |
| *** miloa has quit IRC | 15:28 | |
| *** vishakha has joined #openstack-doc | 15:50 | |
| *** brinzhang has quit IRC | 15:52 | |
| *** brinzhang has joined #openstack-doc | 15:52 | |
| *** jawad_axd has joined #openstack-doc | 16:10 | |
| *** alexmcleod has joined #openstack-doc | 16:17 | |
| *** jamesmcarthur has quit IRC | 16:22 | |
| *** jamesmcarthur has joined #openstack-doc | 16:27 | |
| *** amotoki is now known as amotoki_ | 16:42 | |
| *** jamesmcarthur has quit IRC | 16:47 | |
| *** jawad_axd has quit IRC | 17:03 | |
| *** alexmcleod has quit IRC | 17:21 | |
| *** jamesmcarthur has joined #openstack-doc | 17:27 | |
| *** tesseract has quit IRC | 17:30 | |
| *** hemna has quit IRC | 17:47 | |
| *** jamesmcarthur has quit IRC | 17:52 | |
| *** jamesmcarthur has joined #openstack-doc | 19:03 | |
| openstackgerrit | Nicholas Tait proposed openstack/security-doc master: Overhaul token providers for Stein https://review.opendev.org/677505 | 19:04 |
| openstackgerrit | Nicholas Tait proposed openstack/security-doc master: Update the scope of which releases are covered in the security guide https://review.opendev.org/678947 | 19:04 |
| openstackgerrit | Nicholas Tait proposed openstack/security-doc master: Replace a section which rapidly becomes out of date https://review.opendev.org/677494 | 19:30 |
| *** vishakha has quit IRC | 19:58 | |
| *** jamesmcarthur has quit IRC | 20:46 | |
| *** rcernin has joined #openstack-doc | 22:15 | |
| openstackgerrit | Nicholas Tait proposed openstack/security-doc master: Prepare to remove nearly-deprecated checklist items https://review.opendev.org/677513 | 23:23 |
Generated by irclog2html.py 2.15.3 by Marius Gedminas - find it at mg.pov.lt!