borg_the_docs Sub-Action

This GitHub action is invoked by the main NISTtheDocs2Death Action to modify the Sphinx configuration before building the documentation.

Usage

This action is invoked as a step of the composite workflow of the NISTtheDocs2Death Action. There is no reason to invoke this action yourself.

- name: Add cruft to theme
  id: borg-the-docs
  uses: ./../../_actions/current/borg_the_docs
  with:
    docs-folder: 'docs/'
    separated-layout: false

Note

This action must be synchronized with the invoked version of the NISTtheDocs2Death Action, but “usnistgov/NISTtheDocs2Death/borg_the_docs@${{ github.action_ref }}” doesn’t work, hence the clumsy uses: statement.

Inputs

docs-folder

The folder containing your Sphinx configuration.

separated-layout

Whether Sphinx is configued to have separate source/ and build/ directories.

Outputs

borged-docs-folder

The folder containing the Sphinx configuration modified by this Action.

Implementation

This action implements a Docker workflow step. The Docker ENTRYPOINT installs any requirements.txt in the Sphinx configuration directory, wraps the conf.py file with a BorgedConfFile object, and invokes assimilate_theme().

API

borg_the_docs_action