Document fixes for lint errors
howto/code/lint/index.rst
howto/code/lint/fix-errors
--------------------------
o Added a new 'fixing-errors' section in 'howto: lint'.
howto/code/lint/fix-errors/sphinx/spelling
howto/code/lint/fix-errors/yamllint
------------------------------------------
o Document a few known fixes for common problems.
requirements.txt
----------------
o Capture detail for a python upgrade error uncovered by 'make reload'.
o libdoc command for robot/robotframework having issues.
Change-Id: Iaa700327d374b6040841cbfc98f76ba95c16c799
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
diff --git a/howto/code/lint/fix-errors/index.rst b/howto/code/lint/fix-errors/index.rst
new file mode 100644
index 0000000..e48d6a8
--- /dev/null
+++ b/howto/code/lint/fix-errors/index.rst
@@ -0,0 +1,8 @@
+LINT: Fixing errors
+=========================
+
+.. toctree::
+ :glob:
+
+ sphinx/spelling/*
+ yamllint/*
diff --git a/howto/code/lint/fix-errors/sphinx/spelling/index.rst b/howto/code/lint/fix-errors/sphinx/spelling/index.rst
new file mode 100644
index 0000000..fe040a5
--- /dev/null
+++ b/howto/code/lint/fix-errors/sphinx/spelling/index.rst
@@ -0,0 +1,7 @@
+LINT: Spelling Errors
+=====================
+
+.. toctree::
+ :maxdepth: 2
+
+ spelling-exclusions
diff --git a/howto/code/lint/fix-errors/sphinx/spelling/spelling-exclusions.rst b/howto/code/lint/fix-errors/sphinx/spelling/spelling-exclusions.rst
new file mode 100644
index 0000000..9051fbd
--- /dev/null
+++ b/howto/code/lint/fix-errors/sphinx/spelling/spelling-exclusions.rst
@@ -0,0 +1,31 @@
+LINT: Spelling exclusions
+=========================
+
+Correct spelling problems within docs whenever possible but on occasions
+when commands or error message strings are in the dictionary exclusions
+can be added
+
+.. code:: bash
+
+ % make spelling
+
+Spelling exclusion for a special string
+---------------------------------------
+
+- Ignore this `` :spelling:ignore:`bogus-word` ``
+- Quoting: ``item``
+
+Spelling exclusions by list
+---------------------------
+
+Exclude `foo, bar & tans` within a single document.
+.. code:: bash
+
+ `` .. spelling:: ``
+ foo
+ bar
+ tans
+
+.. seealso::
+
+ [managing-lists-of-correctly-spelled-words-and-ignoring-words](https://sphinxcontrib-spelling.readthedocs.io/en/latest/customize.html#managing-lists-of-correctly-spelled-words-and-ignoring-words)
diff --git a/howto/code/lint/fix-errors/yamllint/long-lines.rst b/howto/code/lint/fix-errors/yamllint/long-lines.rst
new file mode 100644
index 0000000..e4d16bf
--- /dev/null
+++ b/howto/code/lint/fix-errors/yamllint/long-lines.rst
@@ -0,0 +1,15 @@
+LINT: Spelling exclusions
+=========================
+
+.. code:: bash
+
+ % make lint-yaml
+
+Folding
+-------
+
+- >, >-, >+
+
+.. seealso::
+
+- https://yaml-multiline.info/
diff --git a/howto/code/lint/index.rst b/howto/code/lint/index.rst
index 0668a27..c061006 100644
--- a/howto/code/lint/index.rst
+++ b/howto/code/lint/index.rst
@@ -4,8 +4,8 @@
.. toctree::
:maxdepth: 1
- index.rst
lint-helm.rst
+ fix-errors
======================================