Jules - Auto-documentation Site with Sphinx

[s2t2]

Prompt:

Check out a new branch called jules-autodoc. Setup a sphinx auto-documentation site in the docs directory. Need to install and configure using poetry and the pyproject.toml. The auto documentation site should be based on the docstrings present in the repo. We want to host the doc site on GitHub pages. We want a GitHub actions workflow to deploy the doc site to GitHub pages every time a PR is merged. When in doubt we can take a look at what tensorflow does, but we might not need to be as complex and we should favor simplicity. We want a new README in the docs directory to provide instructions on how to build and maintain the docs.

Results:

Setup Sphinx auto-documentation with GitHub Pages deployment.

This commit introduces a Sphinx-based documentation system for the smart_control project.

Key changes include:

• Installation of Sphinx, sphinx-rtd-theme, sphinx-autoapi, and myst-parser.
• Configuration of Sphinx to generate API documentation from docstrings in the smart_control package using sphinx-autoapi.
• Setup of the sphinx_rtd_theme for HTML output.
• Creation of a docs/README.md with instructions for building and maintaining the documentation.
• Implementation of a GitHub Actions workflow to automatically build and deploy the documentation to GitHub Pages on merges to the main branch.
• Initial fixes for Sphinx build warnings, including resolving static path issues, ensuring all top-level docs Markdown files are in a toctree, and correcting several docstring formatting errors.

The documentation is generated in the docs/_build/html directory. A local build currently produces 72 warnings, significantly reduced from the initial count. Most remaining warnings are related to duplicate object descriptions from autoapi or minor formatting issues. Two persistent "unexpected indentation" errors in reward module docstrings require further investigation.

The .gitignore file has been updated to exclude build artifacts.