Metadata-Version: 2.1
Name: ohnoyoudidnt
Version: 0.1
Summary: doc8 linter for frc-docs
Home-page: https://github.com/wpilibsuite/ohnoyoudidnt
Author: Vasista Vovveti
Author-email: vasistavovveti@gmail.com
License: UNKNOWN
Description: # 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
        
Platform: UNKNOWN
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
