[Evergreen-documentation] generate-docs.pl

Blake Graham-Henderson blake at mobiusconsortium.org
Tue Aug 20 16:49:41 EDT 2024


Andrea,

Your devs suggested the right thing. Antora is what you're dealing with 
more than generate_docs.pl.

https://docs.antora.org/antora/latest/playbook/content-branches/

-Blake-
Conducting Magic
Will consume any data format
MOBIUS



On 8/20/2024 3:24 PM, Andrea Buntz Neiman via Evergreen-documentation wrote:
> Hi DIG,
>
> I'm looking to run the generate-docs.pl <http://generate-docs.pl> 
> script against a couple of my local branches before I push them upstream.
>
> However, it seems that this only runs a build of main (or at least, is 
> not building with my committed changes from my branch), even if I run 
> the script from within my branch.
>
> I'm using gitbash on Windows 10 and I have .... some kind of perl 
> plugin. I know it works for the release notes perl script.
>
> One of my devs suggested temporarity editing site.yaml on my branch to 
> use my branch name, like so:
>
> [abn-branchname, rel_3_13]
>
> instead of the standard:
>
> [main, rel_3_13, rel_3_12, rel_3_11, rel_3_10, rel_3_9, rel_3_8, 
> rel_3_7, rel_3_6]
>
> But this seems to me like an easy way for me to accidentally bork 
> site.yml if I forget to edit this back after my tests :) :)
>
> Any other thoughts about how to run this perl script on a specific 
> local branch?
>
> Thanks
> ABN
>
> -- 
> Andrea Buntz Neiman, MLS
> Project Manager for Software Development | Product Specialist
> Equinox Open Library Initiative
> abneiman at equinoxOLI.org <mailto:abneiman at equinoxoli.org>
> 1-877-OPEN-ILS (673-6457)
> Direct: 770-709-5583
> _https://www.equinoxOLI.org/ <https://www.equinoxOLI.org/>_
>
> _______________________________________________
> Evergreen-documentation mailing list
> Evergreen-documentation at list.evergreen-ils.org
> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.evergreen-ils.org/pipermail/evergreen-documentation/attachments/20240820/86e16d2c/attachment-0001.htm>


More information about the Evergreen-documentation mailing list