Home CodeDoc How do I view documentation run history and open the file-level details for a run?

How do I view documentation run history and open the file-level details for a run?

Last updated on Nov 10, 2025

Short Answer: Open the Usage tab, locate the run row and click the run’s “View detail” action to open the “Files documented” modal that lists file names, modules, tags, and sizes.

Prerequisites

  1. At least one documentation run in Usage

  2. Permission to view run details

Steps

  1. Open the Usage tab in CodeDoc.
    A table listing documentation runs is visible.

  2. Use the top filters (Repository, Search, Date) to narrow the runs if needed.
    The table displays matching runs.

  3. Find the run you want and click the run’s “View detail” icon in the right-most column.
    A “Files documented” modal opens showing documented files for that run.

  4. Review the columns in the modal: “File name”, “Module”, “Tags”, “Size” and click “Close” when finished.
    You see file-level details and can close the dialog to return to Usage.

Troubleshooting

  1. “No documentation runs yet” message appears.
    LikelyCause: No documentation runs have been executed for this workspace.
    Action: Run documentation via “Generate documentation” or set up Automation to create runs.

  2. “View detail” icon is not present or disabled.
    LikelyCause: You may not have permission to view run details or the run is still processing.
    Action: Check Settings → Documentation settings for permissions and wait for the run to finish.

Note: The “Files documented” modal shows file-level output for the selected run; use it to validate which files were processed.