From ce4148f43b0f99dc7bf7bffe66130e9aab9e654e Mon Sep 17 00:00:00 2001 From: Laurent Perrinet Date: Fri, 1 Dec 2023 16:13:43 +0100 Subject: [PATCH] sync with rootstock --- build/README.md | 15 +++++++++++++-- build/environment.yml | 2 +- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/build/README.md b/build/README.md index 20e72cd..3c09035 100644 --- a/build/README.md +++ b/build/README.md @@ -7,8 +7,19 @@ However, setting the `BUILD_PDF` environment variable to `false` will suppress P For example, run local builds using the command `BUILD_PDF=false bash build/build.sh`. To build a DOCX file of the manuscript, set the `BUILD_DOCX` environment variable to `true`. -For example, use the command `BUILD_DOCX=true bash build/build.sh`. -To export DOCX for all CI builds, set an environment variable (see docs for [GitHub Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables)). +For example, use the command `BUILD_DOCX=true bash build/build.sh` locally. +To export DOCX for all CI builds, set an environment variable in the CI configuration file. +For GitHub Actions, set the variable in `.github\workflows\manubot.yaml` (see [docs](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables)): + +```yaml +name: Manubot +env: + BUILD_DOCX: true +``` + +To generate a single DOCX output of the latest manuscript with GitHub Actions, click the "Actions" tab at the top of the repository. +Select the "Manubot" workflow, then the "Run workflow" button and check "generate DOCX output" before clicking the green "Run workflow" button. + Currently, equation numbers via `pandoc-eqnos` are not supported for DOCX output. Format conversion is done using [Pandoc](https://pandoc.org/MANUAL.html). diff --git a/build/environment.yml b/build/environment.yml index 30fb360..d6f66fd 100644 --- a/build/environment.yml +++ b/build/environment.yml @@ -21,7 +21,7 @@ dependencies: - pip: - cffi==1.15.0 - errorhandler==2.0.1 - - git+https://github.com/manubot/manubot@d4242ffa4194e4a13a68c5f6466feff559d3f9d5 + - git+https://github.com/manubot/manubot@6e6f6a5aac381120faf3ef02e594b5babc77da2b - isbnlib==3.10.10 - opentimestamps-client==0.7.1 - opentimestamps==0.4.3