Skip to content

Rebuilding documentation

Michael Penkov edited this page Aug 24, 2023 · 1 revision

Gensim maintainers have a Github Actions workflow for rebuilding the documentation: https://github.com/RaRe-Technologies/gensim/actions/workflows/build-docs.yml

This is helpful if you don't want to (or are unable to) build the documentation locally. To use the workflow, you need to be a Gensim maintainer

  1. Push the contributor's work to a branch under the gensim repo
  2. Go to https://github.com/RaRe-Technologies/gensim/actions/workflows/build-docs.yml and click on the "Run workflow" dropdown
  3. Select the branch you pushed to and click "Run workflow"
  4. Wait for the workflow to complete
  5. The finished workflow will produce an artifact in the form of a patch (example)
  6. Download the patch, unzip it, and apply it to the contributor's work (git apply </path/to/patch>)
  7. Push the changes to the contributor's remote (git push )