Skip to content

Revise and improve mission documentation build #877

@keegan-moore

Description

@keegan-moore

Checklist (Please check before submitting)

  • I reviewed the Contributing Guide.
  • I performed a cursory search to see if the bug report is relevant, not redundant, nor in conflict with other tickets.

Describe the bug

In the following issues / PRs, we identified a failing mission-doc build:

The error seemed to be caused because the output mission doc PDF was far too large.
In those PRs, we disabled that workflow (to prevent the noise in the pipeline).

This issue is a follow-on to work the larger effort to fix the mission documentation.

We were generating the following:

  1. cFE User Guide
  2. OSAL API Guide
  3. Combined Mission Documentation

The third seemed to be a combo of the first two, plus additional documentation from each app in the build.
Instead, perhaps we should update the pipeline to generate a PDF for each of the modules separately, rather than combining them together. That way, each of the resulting files is more likely to stay under the size limits of pandoc/latex.

To Reproduce

  • Rerun the workflows from the v7.0.0 draco tags, or one of PRs that started experiencing these errors (listed below in additional context)

Expected behavior

  1. Documentation Builds pass
  2. Documents are manageable (not too large, well-scoped, no duplicates)

Code snips
N/A

System observed on:

  • Ubuntu / GitHub Runner containers

Additional context

The failing mission doc builds started with the v7.0.0 draco updates:

Reporter Info
Keegan Moore / NASA GSFC

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions