Fix too short title underlines/overlines in documentation#2094
Closed
dnskr wants to merge 2 commits into
Closed
Conversation
tatiana
requested changes
Nov 10, 2025
Collaborator
tatiana
left a comment
tatiana
left a comment
There was a problem hiding this comment.
@dnskr Thanks for fixing Sphinx warnings. Your PRs have great description and content.
Similar to the feedback given in:
#2096 (review)
I noticed PR #2095 also solves Sphinx errors. Please, unify these PRs into a single one (I'll close the other PR), giving the PR a generic title (e.g. docs: Fix Sphinx warnings).
If there are any other warnings being raised by Sphix, it would be great to have them fixed as part of this same PR.
2 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2094 +/- ##
=======================================
Coverage 97.81% 97.81%
=======================================
Files 92 92
Lines 5951 5951
=======================================
Hits 5821 5821
Misses 130 130 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2 tasks
Contributor
Author
|
Closed in favor of a single PR, as suggested in the review comment. |
tatiana
pushed a commit
that referenced
this pull request
Nov 17, 2025
## Description This PR consolidates the following PRs that address documentation formatting issues as suggested in the [review](#2096 (review)) provided: - #2094 - #2095 - #2096 - #2097 It also fixes the following issues: ``` ./astronomer-cosmos/docs/getting_started/execution-modes.rst:209: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils] ./astronomer-cosmos/docs/getting_started/execution-modes.rst:236: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils] ./astronomer-cosmos/docs/getting_started/execution-modes.rst:293: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils] ./astronomer-cosmos/docs/getting_started/execution-modes.rst:329: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils] ./astronomer-cosmos/docs/getting_started/gcp-cloud-run-job.rst:6: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils] ``` ## Breaking Change? No ## Checklist - [ ] I have made corresponding changes to the documentation (if required) - [ ] I have added tests that prove my fix is effective or that my feature works
✅ Deploy Preview for sunny-pastelito-5ecb04 canceled.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The PR fixes the following warnings that are printed during documentation building:
Breaking Change?
No
Checklist