G
YouTube TikTok Games
Skip to content

Documentation build hides reStructuredText syntax errors #521

Closed

Description

@PierreRaybaut

Description

doc/conf.py sets suppress_warnings = ["docutils"]. The documentation build therefore succeeds with -W even when the reStructuredText is invalid (e.g. title underlines that are too short, or a title directly followed by a list), so such errors go unnoticed and may change the rendering.

Expected behavior

Syntax errors of the documentation sources are reported by the build.

Proposed change

Find out why the docutils warnings were suppressed (e.g. warnings raised by third-party docstrings), fix the remaining errors and restrict the suppression to what is necessary.

Activity

  1. added this to the Backlog milestone on Nov 11, 2026
  2. modified the milestones: Backlog, v1.4.1 on Nov 12, 2026
  3. PierreRaybaut commented on Nov 12, 2026

    @PierreRaybaut
    ContributorAuthor

    Fixed by #537 (merged into release) and #538 (cherry-pick merged into develop).

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions