[Sphinx] Fix rst underline length warnings #3382
Closed
+18
−18
Conversation
This file contains 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
facebook-github-bot
added
the
CLA Signed
|
@CristianLara has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Summary: ## These changes Fixes errors like ```shell ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [docutils] /home/runner/work/Ax/Ax/sphinx/source/modelbridge.rst:388: WARNING: Title underline too short. ``` From the [official RST documentation](https://docutils.sourceforge.io/docs/user/rst/quickstart.html#sections): > The underline/overline must be at least as long as the title text. ## Next steps We currently ignore warnings and errors in our sphinx build. There's more work needed to fix all the current warnings and errors before we can start blocking deploys on this. We currently build sphinx for testing in the "Build and Test Workflow" https://github.com/facebook/Ax/actions/runs/13395675240/job/37413955185#step:7:207 I took a stab at fixing other errors but the loop of 1. attempt fix 2. rebuild sphinx docs to reveal errors 3. grep logs to see if fix resolved our specific error is painfully slow. I tried using a [flake8-rst extension](https://github.com/peterjc/flake8-rst-docstrings) to reveal the errors in my editor but they didn't match the output of sphinx. Creating a backlog task for the remaining work Reviewed By: paschai Differential Revision: D69794692 Pulled By: CristianLara
facebook-github-bot
force-pushed
the
sphinx-fix-some-warnings
branch
from
d7c4044 to
90b1cb0
Compare
|
This pull request was exported from Phabricator. Differential Revision: D69794692 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3382 +/- ##
=======================================
Coverage 95.99% 95.99%
=======================================
Files 539 539
Lines 52727 52727
=======================================
Hits 50614 50614
Misses 2113 2113 ☔ View full report in Codecov by Sentry. |
|
@CristianLara merged this pull request in 9db61c5. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
These changes
Fixes errors like
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [docutils] /home/runner/work/Ax/Ax/sphinx/source/modelbridge.rst:388: WARNING: Title underline too short.From the official RST documentation:
Next steps
We currently ignore warnings and errors in our sphinx build. There's more work needed to fix all the current warnings and errors before we can start blocking deploys on this. We currently build sphinx for testing in the "Build and Test Workflow" https://github.com/facebook/Ax/actions/runs/13395675240/job/37413955185#step:7:207
I took a stab at fixing other errors but the loop of
is painfully slow. I tried using a flake8-rst extension to reveal the errors in my editor but they didn't match the output of sphinx.
Creating a backlog task for the remaining work