[DOCUMENTATION] Apply changes as per Review (- WIP PR #228 -)

Changes in file .readthedocs.yaml:
 - fixed style regression
 - added more coments
 - added simple success testing

Changes in file docs/FAQ.md:
 - added well placed punctuation.

Changes in file tests/__init__.py:
 - added more to the docstrings.

Author: reactive-firewall

.readthedocs.yaml

@@ -37,8 +37,8 @@ build:
     pre_build:
       # Build the project module that is to be documented ; continue even if build fails
       - make build || true
-      # build the documentation ; avoid crashing even if docs fail
-      - make -j1 build-docs || true
+      # Build docs and verify output exists
+      - make -j1 build-docs && test -d docs/www/_build/html
     post_build:
       # Move built documentation into place ; ignore if fails
       - cp -vfRp docs/www/_build/html/ "$READTHEDOCS_OUTPUT" || true
@@ -57,6 +57,7 @@ sphinx:
 #
 # Note:
 # - Enabling PDF output requires LaTeX installed in the build environment
+#   - PDF output requires texlive-latex-recommended and texlive-fonts-recommended packages
+#   - PDF builds may significantly increase build time and output size
 # - Ensure all documentation content is compatible with these formats
 # - Assess user demand for offline documentation before enabling
-

docs/FAQ.md

@@ -228,7 +228,7 @@ work so far as this Multicast module is concerned.
 
 ### How do I build the documentation?
 
-* Typically the documentation will be automatically built by CI/CD and posted to the official
+* Typically, the documentation will be automatically built by CI/CD and posted to the official
   documentation site.
 
 * However if one still wishes to manually build the documentation, there is a make target for this:

tests/__init__.py

@@ -24,6 +24,12 @@
 	This package provides comprehensive testing coverage for various multicast functionalities
 	including server operations, data processing, cleanup routines, and exception handling.
 
+	For specific test cases, see:
+		- Server operations: test_hear_server.McastServerTestSuite
+		- Data processing: test_hear_data_processing.RecvDataProcessingTestSuite
+		- Cleanup routines: test_hear_cleanup.HearCleanupTestSuite
+		- Exception handling: test_exceptions.ExceptionsTestSuite
+
 	Robust imports: These statements import the entire "multicast" module,
 		allowing access to all its functionalities within the test environment.
 		This may be flagged as an intentional cyclic import by pylint.