https://github.com/wpilibsuite/ohnoyoudidnt

Sphinx linter for frc-docs
https://github.com/wpilibsuite/ohnoyoudidnt

Last synced: about 1 month ago
JSON representation

Sphinx linter for frc-docs

• Host: GitHub
• URL: https://github.com/wpilibsuite/ohnoyoudidnt
• Owner: wpilibsuite
• Created: 2020-12-24T19:14:16.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2020-12-25T22:39:28.000Z (over 4 years ago)
• Last Synced: 2025-04-14T12:06:19.394Z (about 1 month ago)
• Language: Python
• Size: 18.6 KB
• Stars: 4
• Watchers: 9
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ohnoyoudidnt

![ci](https://github.com/wpilibsuite/ohnoyoudidnt/workflows/ci/badge.svg)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

ohnoyoudidnt is a doc8 sphinx linter intended for use by [frc-docs](https://github.com/wpilibsuite/frc-docs). Its an expansion to the normal doc8 linter with custom checks intended to follow the frc-docs [styleguide](https://docs.wpilib.org/en/stable/docs/contributing/style-guide.html)

Project created by [TheTripleV](https://github.com/thetriplev)

## Usage

### Manual

1. Ensure [doc8](https://pypi.org/project/doc8/) is installed.

2. Install ohnoyoudidnt

```python

python -m pip install ohnoyoudidnt

```

3. Run the linter using

```

doc8

```

### VS Code

1. Follow instructions 1 and 2 from above

2. Install the `reStructuredText` VS Code extension

3. Add

```json

    "restructuredtext.linter.name": "doc8",

    "restructuredtext.linter.extraArgs": [

        "--ignore D001",

        "--ignore D004",

        "--ignore D002",

        "--ignore WUMBO002"

    ],

```

to your `settings.json` file.

## Contribution Guidelines

### Checks

- Checks can never yield a line number < 1

- Checks must compile regex patterns once per import, not once per file