Fun with linters (#45)

* Update README.md to point to Github Pages

* Appease natural language linter

* examples/fabric_details.py - Add documentation

* Update linter configs

pyproject.toml: Remove isort profile=black
isort.ini: Update line length to 180 (isort.ini is not being used currently, AFAIK)

* update docs

* Update docs

docs/classes/overview.md: Fix name and link to ReadConfig

* docs: read_config.py, fix filename in URL

* overview.md: Fix formatting

Also update .gitignore to ignore .prettierrc

* prettier ignore all markdown

* markdownlint: disable long like checking

examples/fabric_details.py: once again fix isort maybe

* isort: disable use_parentheses

* Fix import

* Remove linters/isort.ini, flake8.ini

* Appease linters

* Sigh

Author: allenrobel

.github/linters/.markdown-lint.yml

@@ -1,8 +1,6 @@
 ---
-MD013:
-  line_length: 256            # Line length 80 is far to short
-MD004: false                  # ul-style, * is allowed by material
-MD007: false                  # ul-indent, material not indenting with 2 spaces
-MD040: false                  # Allow ``` blocks with no language specified
-MD046: false                  # Disable Expected: indented; Actual: fenced
-
+MD013: false  # Very long lines in some of the example script output that we want to preserve
+MD004: false  # ul-style, * is allowed by material
+MD007: false  # ul-indent, material not indenting with 2 spaces
+MD040: false  # Allow ``` blocks with no language specified
+MD046: false  # Disable Expected: indented; Actual: fenced

.github/linters/flake8.ini

@@ -1,2 +1,2 @@
-# Ignore markdown
-**/*.md
+# Disable this POS
+**/*

.github/linters/isort.ini

@@ -73,7 +73,9 @@
 from ndfc_python.validators import FabricDetailsConfigValidator
 
 # fmt: off
-from plugins.module_utils.common.api.v1.lan_fabric.rest.control.fabrics.fabrics import EpFabricDetails
+from plugins.module_utils.common.api.v1.lan_fabric.rest.control.fabrics.fabrics import (
+    EpFabricDetails,
+)
 
 # fmt: on
 from plugins.module_utils.common.response_handler import ResponseHandler

.prettierignore

@@ -14,7 +14,7 @@ force_grid_wrap = 0
 line_length = 180
 multi_line_output = 3
 skip_glob = ["docs/*"]
-use_parentheses = true
+use_parentheses = false
 
 [tool.pylint.main]
 disable = ["too-many-instance-attributes", "too-many-lines", "too-many-public-methods", "wrong-import-order"]