search

sagemath / sage-patchbot

Sage Patchbot
https://www.sagemath.org
Other
8 stars 17 forks source link

Compile the pdf documentation and report on error #64

Open nthiery opened 9 years ago

nthiery commented 9 years ago

I recently wasted some good release manager time by setting a positive review on a ticket where the pdf documentation actually did not build. It would be a nice addition if the patchbot would try to build the pdf documentation and report on the result. I grepped for pdf in the patchbot sources and did not find any match, so this is not the case now, right?

A difficulty might be that building the pdf doc requires quite a few dependencies (pdflatex, many packages, ...). So maybe this should be optional.

Thanks!

fchapoton commented 9 years ago

Yes, this is not the case now. The bot always run "make doc-clean" then "make", so it builds the html doc I have started to prepare a plugin "docbuild_pdf" that will run "make doc-pdf" This has not been tested yet. It will certainly not be activated by default.

fchapoton commented 9 years ago

Which ticket was it ? What was the error ?

nthiery commented 9 years ago

See trac.sagemath.org/ticket/16659#comment:98. Thanks!

fchapoton commented 8 years ago

There exists a plugin "docbuild_pdf", that is not activated by default. I think nobody has tried to use it.

videlec commented 8 years ago

Sadly it is not that simple to allow an extra plugin... the point is that the list of plugins should appear in a given order and "docbuild_pdf" should appear right after the "docbuild_html". The only way I know to achieve that is to copy/paste the list from patchbot.py into my configuration file with the "docbuild_pdf" inserted at the right place. It would be easier with a more extensible configuration with

What do you think?

fchapoton commented 8 years ago

Je ne comprend pas. Have you tried just to enable the doc_pdf plugin on one of your bot using your json config file? It should not matter whether or not you build the pdf doc before or after the html doc, no ?

videlec commented 8 years ago

The order of plugins does matter... anyway how do you enable the doc_pdf plugin?

fchapoton commented 8 years ago

In principle, you just write it inside your custom plugin list, in the json config file.

2016-08-04 18:50 GMT+02:00 Vincent Delecroix notifications@github.com:

The order of plugins does matter... anyway how do you enable the doc_pdf plugin?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/sagemath/sage-patchbot/issues/64#issuecomment-237613290, or mute the thread https://github.com/notifications/unsubscribe-auth/AFM8AO11_1YTC_vac09OUQR_bY3Cdtpwks5qchg5gaJpZM4EOkey .

videlec commented 8 years ago

Looking at the code: the entry "plugins" in the configuration is the list of all plugins. In other words, I do not see how to enable the doc pdf plugin without copy/paste from the code.

fchapoton commented 8 years ago

yes, indeed. But this offers the possibility to add and remove all plugins at will. The docbuild one is forced in any case because otherwise doctests are failing.

2016-08-04 20:09 GMT+02:00 Vincent Delecroix notifications@github.com:

Looking at the code: the entry "plugins" in the configuration is the list of all plugins. In other words, I do not see how to enable the doc pdf plugin without copy/paste from the code.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/sagemath/sage-patchbot/issues/64#issuecomment-237635501, or mute the thread https://github.com/notifications/unsubscribe-auth/AFM8AHHoNdh9xeiOE0zPH0AAtWpsBMmYks5qciq9gaJpZM4EOkey .

videlec commented 8 years ago

Hence you can reread my previous message which propose an alternative implementation with more options. We can even follow more standard terminology with

fchapoton commented 8 years ago

ok, indeed. Feel free to implement something like that, but please keep things simple.

2016-08-04 20:21 GMT+02:00 Vincent Delecroix notifications@github.com:

Hence you can reread my previous message which propose an alternative implementation with more options. We can even follow more standard terminology with

  • "plugins_available" : the list of available plugins. The order will be respected at execution.
  • "plugins_enabled": the list of extra plugins to enable (a list of extra plugin to be added to the default ones)
  • "plugins_disabled": the list of plugins to disable (a list of plugins to disable from the default ones)

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/sagemath/sage-patchbot/issues/64#issuecomment-237639110, or mute the thread https://github.com/notifications/unsubscribe-auth/AFM8AKTh7RSPVPkLMFX5Aqix3QWpMXxOks5qci2hgaJpZM4EOkey .

videlec commented 8 years ago

now sagemath/sage-patchbot#91

mkoeppe commented 2 years ago

For the list of needed latex packages, see https://trac.sagemath.org/ticket/31529, which needs help