forked from facebook/Ax
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix rst underline length warnings (facebook#3382)
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 Pull Request resolved: facebook#3382 Reviewed By: paschai Differential Revision: D69794692 Pulled By: CristianLara fbshipit-source-id: d45ad855597ed44ad787c0b357e9c94873284b49
- Loading branch information
1 parent
2a0d7a5
commit 9db61c5
Showing
5 changed files
with
18 additions
and
18 deletions.
There are no files selected for viewing
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
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
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
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
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