Skip to content

docs/scripts: Fix sphinx_build_link_check.sh name and comment — script does not run link check #284

Description

@Shivampal157

Summary

The script docs/scripts/sphinx_build_link_check.sh is named and commented as if it builds docs and checks links, but it only runs a Sphinx build. The link-check step is missing, so the name and comment are misleading.

Problem

  • Script name: sphinx_build_link_check.sh suggests it builds and then checks links.
  • Comment in script: "Build locally, and then check links"
  • Actual behavior: The script only runs:h
    sphinx-build -E -W source build

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions