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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ohnoyoudidnt-0.1.tar.gz
(6.0 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ohnoyoudidnt-0.1.tar.gz.
File metadata
- Download URL: ohnoyoudidnt-0.1.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9fa36f3589b9f7c58330efae4cd2ea276b1a7cc6cc60d30516144b1e17e9b0a0
|
|
| MD5 |
4c378963eec2093da85167118157cb36
|
|
| BLAKE2b-256 |
24fc9eb1a1d3e83b6773567186f60ff4ae168f09b6c018aa012dcbc1215c7a41
|
File details
Details for the file ohnoyoudidnt-0.1-py3-none-any.whl.
File metadata
- Download URL: ohnoyoudidnt-0.1-py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
951d322d47b29fe3634003b056059172cdcfc635ab88eb1f1a7ea13822c78a74
|
|
| MD5 |
46e7f7dc6693df86db719ca250373875
|
|
| BLAKE2b-256 |
92d81b84349297a73b9d92a0ecb2b7d4b9d52e82af62bb76a31886907b6407de
|
