Adding Dockerfiles

[tcolo]

Changed Requirements.txt minor version and added docker file for doc envinroment plus generation bash script for easy regeneration of the documentation

[Copilot]

Pull request overview

Adds a Docker-based workflow for building the Sphinx documentation, and updates a pinned Python dependency version to support that doc build environment.

Changes:

• Bump PyYAML pin from 6.0 to 6.0.3 in requirements.txt.
• Add a minimal doc-build Docker image (docker/Dockerfile) and a helper script (docker.sh) to rebuild docs via Docker.
• Add a build-hash file used by the helper script (.docker.buildhash).

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 5 comments.

File	Description
requirements.txt	Updates a pinned dependency version (PyYAML) for the docs toolchain.
docker/Dockerfile	Introduces a Python-based doc build image with git installed and requirements installed.
docker.sh	Adds a local helper to build (when inputs change) and run the doc generation in Docker.
.docker.buildhash	Stores the last build input hash for docker.sh’s incremental rebuild behavior.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

pip install without --no-cache-dir will leave pip caches in the image and bloat it unnecessarily. Consider using no-cache installs (and optionally disabling pip version checks) to keep the doc image smaller and more reproducible.

Suggested change

	RUN pip install -r /app/requirements.txt
	RUN pip install --no-cache-dir -r /app/requirements.txt

[Copilot]

This file looks like a local build artifact produced by docker.sh and will change whenever requirements.txt or the Dockerfile changes. Committing it will create churn and conflicts; it should typically be removed from the repo and ignored instead.

[tcolo]

I remove this. Should not be be in git

[Copilot]

The script has no shebang and no strict error handling; running it as ./docker.sh may fail (depending on shell) and a failed docker build will still proceed to docker run. Add a #!/usr/bin/env bash shebang and enable strict mode (e.g., exit-on-error and unset-variable checks) so failures stop the script early.

[Copilot]

This script writes to .docker.buildhash in the repo root. Since that file is committed in this PR, running the script will constantly dirty the working tree and can cause needless merge conflicts. Consider not committing the hash file (and adding it to .gitignore), or storing it under an ignored location (e.g., in a temp/cache dir).

[Copilot]

The docs configuration enables sphinx.ext.imgmath (SVG output). That typically requires LaTeX + a converter like dvisvgm; the image currently only installs git, so doc builds may fail or omit math rendering. Install the required system packages in the Dockerfile (or switch to a math renderer that doesn’t require TeX tooling) so the container reliably builds the docs.

Suggested change

	&& apt-get install -y --no-install-recommends git \
	&& apt-get install -y --no-install-recommends git texlive-latex-base dvisvgm \

[MuhammadTahaNaveed]

@tcolo can you please review copilot's suggestions