chore: move to exclude only logic based on toc.txt

Exclude all documents with an rst suffix not explicitly listed in the
toc.txt. This removes a lot of dead logic and unnecessary config values.

For a while this project mixed including and excluding document logic,
where the include list was provided as an exhaustive description of
everything through the toc.txt and a basic exclude list was provided as
a sparse array populated manually in the OS tags.py file.

This sparse array was supposed to change the way we searched for index
files (previously referred to as toctreefiles), but ultimately any index
files we needed were already listed in the main toc.txt.

Signed-off-by: Randolph Sapp <[email protected]>

Author: StaticRocket

conf.py

@@ -260,9 +260,6 @@
 
 # -- Tag file loader ------------------------------------------------------
 
-# Defaults
-exclude_patterns = []
-
 FAMILY = os.environ.get("DEVFAMILY", "")
 OS = os.environ.get("OS", "")
 try:
@@ -277,6 +274,9 @@
 # Family Configuration file to use
 family_config_inputfile = f"{FAMILY}/{FAMILY}_{OS}_config.txt"
 
+# Set document exclusion list from the tocfiles
+exclude_patterns = sectinc.generate_exclude_patterns(family_tocfiles)
+
 # Hash table for Replacement Variables and Config Values
 family_replacevars, family_configvals = interpretvalues.read_familyvals(family_config_inputfile)
 
@@ -299,16 +299,6 @@ def setup(app):
     print("family_configvals = ")
     print(family_configvals)
 
-    # Determine which sections need to be excluded
-    sectinc.find_all_rst_files(app, exclude_patterns)
-    sectinc.fill_docs_to_keep(app, family_tocfiles, 0)
-    sectinc.set_excluded_docs(app, exclude_patterns)
-    print(FAMILY + " exclude_patterns is:")
-    print('[')
-    for elem in exclude_patterns:
-        print(elem)
-    print(']')
-
     # Load family config values into application context
     for key, value in family_configvals.items():
         app.add_config_value(key, value, 'env')

configs/AM335X/AM335X_linux_tags.py

@@ -9,9 +9,5 @@
 # The master toctree document.
 master_doc = 'devices/AM335X/linux/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM335X/rtos', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX', 'devices/AM62LX']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'linux'

configs/AM437X/AM437X_linux_tags.py

@@ -9,9 +9,5 @@
 # The master toctree document.
 master_doc = 'devices/AM437X/linux/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM437X/rtos', 'devices/AM335X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX', 'devices/AM62LX']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'linux'

configs/AM57X/AM57X_linux_tags.py

@@ -9,9 +9,5 @@
 # The master toctree document.
 master_doc = 'devices/AM57X/linux/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['rtos', 'android', 'linux/index.rst', 'devices/AM57X/rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62AX', 'devices/AM62PX', 'devices/AM62LX']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'linux'

configs/AM62AX/AM62AX_linux_tags.py

@@ -10,12 +10,5 @@
 # The master toctree document.
 master_doc = 'devices/AM62AX/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-
-# AM62Ax RTOS docs are not in this project, rather referenced externally,
-# so exclude 'rtos' folder along with others.
-exclude_patterns = ['android', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62X', 'devices/AM62PX', 'devices/AM62LX']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'linux'

configs/AM62LX/AM62LX_buildroot_tags.py

@@ -10,13 +10,6 @@
 # The master toctree document.
 master_doc = 'devices/AM62LX/buildroot/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-
-# AM62x RTOS docs are not in this project, rather referenced externally,
-# so exclude 'rtos' folder along with others.
-exclude_patterns = ['android', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM62PX', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX', 'linux', 'debian']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'buildroot'
 

configs/AM62LX/AM62LX_debian_tags.py

@@ -10,13 +10,6 @@
 # The master toctree document.
 master_doc = 'devices/AM62LX/debian/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-
-# AM62x RTOS docs are not in this project, rather referenced externally,
-# so exclude 'rtos' folder along with others.
-exclude_patterns = ['android', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM62X', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'debian'
 

configs/AM62LX/AM62LX_linux_tags.py

@@ -10,13 +10,6 @@
 # The master toctree document.
 master_doc = 'devices/AM62LX/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-
-# AM62x RTOS docs are not in this project, rather referenced externally,
-# so exclude 'rtos' folder along with others.
-exclude_patterns = ['android', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/DRA821A', 'devices/AM62AX','devices/AM62PX']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'linux'
 

configs/AM62PX/AM62PX_android_tags.py

@@ -10,14 +10,6 @@
 # The master toctree document.
 master_doc = 'devices/AM62PX/android/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-
-# AM62x RTOS docs are not in this project, rather referenced externally,
-# so exclude 'rtos' folder along with others.
-exclude_patterns = ['files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/DRA821A']
-#exclude_patterns = ['devices/AM62X']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'android'
 

configs/AM62PX/AM62PX_debian_tags.py

@@ -10,13 +10,6 @@
 # The master toctree document.
 master_doc = 'devices/AM62PX/debian/index'
 
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-
-# AM62x RTOS docs are not in this project, rather referenced externally,
-# so exclude 'rtos' folder along with others.
-exclude_patterns = ['android', 'files', 'rtos', 'devices/AM335X', 'devices/AM437X', 'devices/AM64X', 'devices/AM62X', 'devices/AM65X', 'devices/J7_Family', 'devices/J721E', 'devices/J7200', 'devices/J721S2', 'devices/J784S4', 'devices/DRA821A', 'devices/AM62AX', 'devices/AM62LX']
-
 # OS for the build. Sphinx uses source/{sdk_os} when looking for doc inputs
 sdk_os = 'debian'