ohnoyoudidnt
ohnoyoudidnt is a doc8 sphinx linter intended for use by frc-docs. Its an expansion to the normal doc8 linter with custom checks intended to follow the frc-docs styleguide
Project created by TheTripleV
Usage
Manual
- Ensure doc8 is installed.
- Install ohnoyoudidnt
python -m pip install ohnoyoudidnt
- Run the linter using
doc8
VS Code
- Follow instructions 1 and 2 from above
- Install the
reStructuredTextVS Code extension - Add
"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
1 maintainer
Metadata
1 maintainer
Release files for ohnoyoudidnt 0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ohnoyoudidnt-0.1.tar.gz | 6.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ohnoyoudidnt-0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.5 kB
Release files / ohnoyoudidnt-0.1.tar.gz
| Download URL | ohnoyoudidnt-0.1.tar.gz |
|---|---|
| Size | 6.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9fa36f3589b9f7c58330efae4cd2ea276b1a7cc6cc60d30516144b1e17e9b0a0
|
|
BLAKE2b-256 checksum How to use checksums |
24fc9eb1a1d3e83b6773567186f60ff4ae168f09b6c018aa012dcbc1215c7a41
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.7
|
Release files / ohnoyoudidnt-0.1-py3-none-any.whl
| Download URL | ohnoyoudidnt-0.1-py3-none-any.whl |
|---|---|
| Size | 6.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
951d322d47b29fe3634003b056059172cdcfc635ab88eb1f1a7ea13822c78a74
|
|
BLAKE2b-256 checksum How to use checksums |
92d81b84349297a73b9d92a0ecb2b7d4b9d52e82af62bb76a31886907b6407de
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.1.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.8.7
|
