]> git.evergreen-ils.org Git - working/Evergreen.git/commit
LP1930099: Make generate_docs.pl Windows-compatible
authorJane Sandberg <sandbergja@gmail.com>
Thu, 4 Jan 2024 21:58:16 +0000 (13:58 -0800)
committerGalen Charlton <gmc@equinoxOLI.org>
Fri, 22 Mar 2024 18:46:04 +0000 (14:46 -0400)
commitcacae19b9dca0321d96909a7b5b3c2f801717bc7
treee71a4bc949a4ad75d18ff7747aebbdf566fdb7e8
parent7775c5e1dcd74c354f249849c863d774f339b5d9
LP1930099: Make generate_docs.pl Windows-compatible

* Use `npx` rather than relying on specific paths to
binaries within node_modules.
* Use the cross-platform $ENV and File::Copy provided
by Perl, rather than using the platform-specific
command-line syntax.

To test on Windows:
1) Use the instructions provided in the comment at
the top of generate_docs.pl.
2) Make sure that the locally generated documentation
displays correctly in your browser.

To test for regressions on Linux or MacOs:
1) `cd /path/to/Evergreen/docs && perl generate_docs.pl`
2) Make sure that the locally generated documentation
at /path/to/Evergreen/docs/output/index.html displays
correctly in your browser.

Release-note: Allow Windows users to generate the Evergreen manual locally.

Signed-off-by: Jane Sandberg <sandbergja@gmail.com>
Signed-off-by: Galen Charlton <gmc@equinoxOLI.org>
Signed-off-by: Andrea Buntz Neiman <abneiman@equinoxOLI.org>
docs/generate_docs.pl