Skip to content

Fix Sphinx error in CLI reference docs for dags test command - #71120

Open
roykoand wants to merge 1 commit into
apache:mainfrom
roykoand:fix-dags-test-help-rest-error
Open

Fix Sphinx error in CLI reference docs for dags test command#71120
roykoand wants to merge 1 commit into
apache:mainfrom
roykoand:fix-dags-test-help-rest-error

Conversation

@roykoand

@roykoand roykoand commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

The CLI reference docs page is generated from the argparse help strings, and the dags test description was not valid reStructuredText: without a blank line before the numbered list, docutils reported "Unexpected indentation" and Sphinx rendered a System Message error box instead of the usage examples on cli-and-env-variables-ref.html. Verify by checking this URL - https://airflow.apache.org/docs/apache-airflow/stable/cli-and-env-variables-ref.html#test_repeat1


Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)
    Claude Code

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

The CLI reference docs page is generated from the argparse help strings,
and the dags test description was not valid reStructuredText: without a
blank line before the numbered list, docutils reported "Unexpected
indentation" and Sphinx rendered a System Message error box instead of
the usage examples on cli-and-env-variables-ref.html.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant