Documentation now generates from docscript comments in code files!

[TaylorGilg]

Summary

The Mkdocs documentation now uses the docstrings plugin to generate html pages from docstrings comments on code files. Documentation can now adapt to new code changes automatically.

• I know main has changed a bit since I developed the first documentation pages so I'll probably go through and improve commenting and look into any files I'm currently missing. I'll also try to see if I can compact all the markdown files in the pysquared/pysquared/docs folder into one file.
• Nate brought up utilizing AI to make our documentation even more accessible so next I'll look into how to create a type of deepwiki so people can ask questions to our source code.

How was this tested

• Added new unit tests
• Ran code on hardware (screenshots are helpful)
• Other (Please describe)

[Copilot]

Pull Request Overview

This PR replaces the existing hand-written Markdown docs in pysquared/docs with an auto-generated API reference using mkdocstrings and updates the MkDocs configuration to drive documentation from code comments.

• Removed all static .md files under pysquared/docs/
• Added root-level mkdocs.yml with mkdocstrings plugin configuration
• Updated pyproject.toml, Makefile, and GitHub Actions for doc build/deploy

Reviewed Changes

Copilot reviewed 28 out of 29 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
pysquared/mkdocs.yml	Deleted (old docs config removed in favor of root mkdocs.yml)
pysquared/docs/*	Deleted all static docs (to be auto-generated)
mkdocs.yml	New root config pointing at code docstrings via mkdocstrings
pyproject.toml	Added mkdocstrings and section-index dependencies
Makefile	Updated docs and docs-deploy targets
.github/workflows/docs.yaml	New workflow to trigger make docs-deploy on push to main
pysquared/config/radio.py	Added detailed docstrings for RadioConfig classes
pysquared/config/config.py	Added detailed docstrings for Config class

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[nateinaction]

Let's try it!