Skip to content

Commit a277be7

Browse files
sciencewhizpjbuterbaugh
authored andcommitted
Add instructions for disablinb VS Code line length linting (#2279)
1 parent 38831de commit a277be7

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

source/docs/contributing/frc-docs/build-instructions.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,14 @@ Text Editors / IDE
1313

1414
For development, we recommend that you use VS Code along with the `reStructuredText extension <https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext>`_. However, any text editor will work.
1515

16+
By default, the reStructuredText extension enables linting with all doc8 features enabled. As frc-docs does not follow the line length lint, add the following to your VS Code ``settings.json`` to disable line length linting.
17+
18+
.. code-block:: json
19+
20+
"restructuredtext.linter.doc8.extraArgs": [
21+
"--ignore D001"
22+
]
23+
1624
Windows
1725
^^^^^^^
1826

0 commit comments

Comments
 (0)