Clean up docs issues
The Sphinx build produces a number of warnings and errors. Some are
rightfully ignored, but many need to be fixed. These are mostly
unindexed pages and misformatted references.
Signed-off-by: Eric Ball <eball@linuxfoundation.org>
Change-Id: I9d7a116dc87083ad2dcab20e31cd479364f298cd
diff --git a/howto/code/lint/fix-errors/index.rst b/howto/code/lint/fix-errors/index.rst
index e48d6a8..20289fc 100644
--- a/howto/code/lint/fix-errors/index.rst
+++ b/howto/code/lint/fix-errors/index.rst
@@ -4,5 +4,5 @@
.. toctree::
:glob:
- sphinx/spelling/*
- yamllint/*
+ sphinx/spelling/spelling-exclusions.rst
+ yamllint/long-lines.rst
diff --git a/howto/code/lint/fix-errors/sphinx/spelling/index.rst b/howto/code/lint/fix-errors/sphinx/spelling/index.rst
deleted file mode 100644
index fe040a5..0000000
--- a/howto/code/lint/fix-errors/sphinx/spelling/index.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-LINT: Spelling Errors
-=====================
-
-.. toctree::
- :maxdepth: 2
-
- spelling-exclusions
diff --git a/howto/code/lint/fix-errors/yamllint/long-lines.rst b/howto/code/lint/fix-errors/yamllint/long-lines.rst
index e4d16bf..2368905 100644
--- a/howto/code/lint/fix-errors/yamllint/long-lines.rst
+++ b/howto/code/lint/fix-errors/yamllint/long-lines.rst
@@ -12,4 +12,4 @@
.. seealso::
-- https://yaml-multiline.info/
+ - https://yaml-multiline.info/
diff --git a/howto/code/lint/index.rst b/howto/code/lint/index.rst
index 01e4f71..4113b3d 100644
--- a/howto/code/lint/index.rst
+++ b/howto/code/lint/index.rst
@@ -4,8 +4,10 @@
.. toctree::
:maxdepth: 1
- lint-helm.rst
- fix-errors
+ lint-chart
+ lint-helm
+ lint-robot
+ fix-errors/index
pre-commit
@@ -40,7 +42,7 @@
.. seealso::
-- :ref:`Makefile Target lint-chart`
-- :ref:`Makefile Target lint-helm`
-- :ref:`Makefile Target lint-robot`
-- :ref:`Makefile Target lint-pre-commit`
+ - :ref:`Makefile Target lint-chart`
+ - :ref:`Makefile Target lint-helm`
+ - :ref:`Makefile Target lint-robot`
+ - :ref:`Makefile Target lint-pre-commit`
diff --git a/howto/code/linting.rst b/howto/code/linting.rst
index 5bf8524..7fd223e 100644
--- a/howto/code/linting.rst
+++ b/howto/code/linting.rst
@@ -58,9 +58,9 @@
.. seealso::
-- :ref:`Makefile Target lint-chart`
-- :ref:`Makefile Target lint-helm`
-- :ref:`Makefile Target lint-robot`
+ - :ref:`Makefile Target lint-chart`
+ - :ref:`Makefile Target lint-helm`
+ - :ref:`Makefile Target lint-robot`
|
@@ -166,8 +166,6 @@
--------
- lint-doc8-all target dependency will create a `python virtual env <https://wiki.opencord.org>`_
-- python 3.10+ requires `virtual env patching <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/patches/>`_ (dynamic, applied when needed).
-- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles-orig/patches/>`__
|
@@ -192,8 +190,6 @@
Notes:
- lint-flake8-all target dependency will create a `python virtual env <https://wiki.opencord.org>`_
-- python 3.10+ requires `virtual env patching <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/patches/>`_ (dynamic, applied when needed).
-- `makefiles/patches/include.mk <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/makefiles-orig/patches/>`__
|
@@ -269,7 +265,6 @@
- pylint the --py3k option is no longer supported by v3.10+
- lint-pylint-all target dependency will create a `python virtual env <https://wiki.opencord.org>`_
-- python 3.10+ requires `virtual env patching <https://gerrit.opencord.org/plugins/gitiles/voltha-docs/+/refs/heads/master/patches/>`_ (dynamic, applied when needed).
|
diff --git a/howto/code/voltha-protos.rst b/howto/code/voltha-protos.rst
index 3dfa20a..17aca59 100644
--- a/howto/code/voltha-protos.rst
+++ b/howto/code/voltha-protos.rst
@@ -88,7 +88,7 @@
- Cleanup syntax issues in golang source that will fail your pending commit
* - go mod vendor
- | Update sources and dependencies beneath the vendor/ directory.
- | See also `go-mod-vendor <https://go.dev/ref/mod#go-mod-vendor>`_, `Packages & Modules <https://golangbyexample.com/packages-modules-go-second/>`_
+ | See also `go-mod-vendor <https://go.dev/ref/mod#go-mod-vendor>`_, `Packages & Modules <https://golangbot.com/go-packages/>`_
* - make build
- Compile with updated module dependencies.
* - make test