Improve catalog update process and script, including tests#889
Conversation
…list to an included catalog.am file
…support editable installs
|
|
||
| When updating the catalog, changes can be viewed by inspecting the documentation build generated by a pull request. | ||
| To test changes locally, you'll need to have a developer install of `pygambit` available in your Python environment, see :ref:`build-python`. | ||
| To test changes locally, you'll need to have an editable developer install of `pygambit` available in your Python environment. |
There was a problem hiding this comment.
You don't need to have an editable install, but it can be a useful technique if you are working only with the catalog. This needs to be written a bit more carefully though because an editable install doesn't work in general if one is making changes to the C++ part of the code.
This edit might be more confusing than helpful to a less-experienced dev.
There was a problem hiding this comment.
Fair enough, I can just make that explicit here - the idea is yes in general developer install would not be editable, but when you're making catalog edits this will definitely save a lot of time
…outs for catalog games
… .ef file suffixing
|
@rahulsavani If you have any EF layout variants for the |
Example of how this looks adding 2 EFs for one game when I tested it locally:
|
This looks great. I am reviewing the PR now. One immediate comment: The long list of files does not look great -- can we hide it (within the entry) by default and expand it similarly to the whole entry? |
Good idea, have changed that for all the entries and it looks better |
rahulsavani
left a comment
There was a problem hiding this comment.
I really like the tabs for alternatives.
However, at the moment, to get two or more alternatives one needs to add two or more .ef files to the catalog.
I think a typical use case is that one provides one alternative with the other desired one is that created bydraw_tree (i.e. what we used to have before allowing custom .efs at all).
Currently if one provides a {slug}__{label}.ef without a {slug}.ef the former is ignored and one just gets the default draw_tree one. I think in this case the default and the variant should be created.
@rahulsavani Just pushed an updated and that is now the case |
rahulsavani
left a comment
There was a problem hiding this comment.
Thanks, this works nicely. I am happy with this for now.
I added two alternative .efs for vonstengelforges2008; they need some minor tweaks, but I will do that later -- let's get this merged in so you can merge in the bibtex stuff.



Issues closed by this PR
Description of the changes in this PR
python build_support/catalog/update.py --helpbuild_support/catalog/update.pycovering the functions handling DrawTree settings, updating the variables passed to theMakefile.amand correctly generating the catalog RST docHow to review this PR