feat: replace pdoc with MkDocs

[SimonJasansky]

This PR adds support for mkdocs (Material Theme) as a documentation framework, and supports automatic deployment of the docs to GitHub Pages

New features:

• Replaced pdoc with mkdocs
• One shared Github Action to deploy the docs, triggered on push to main

How to test:

• Create a dummy repository
• test docs locally with mkdocs build and mkdocs serve
• Commit and push to GitHub
• Docs will be available at https://<username>.github.io/<repository>

I tested it in this dummy repo here: https://github.com/SimonJasansky/test_substrate, and you can see how the deployed docs look like here: https://simonjasansky.github.io/test_substrate/

Notes:

• For now, automatic deployment is only supported for repos hosted on Github (not for GitLab).

[Copilot]

Pull Request Overview

This PR adds support for MkDocs (Material theme) as a documentation framework option alongside the existing pdoc support, and implements automatic documentation deployment to GitHub Pages for both tools.

• Adds a new documentation_tool question to the copier template with choices for MkDocs, pdoc, or None
• Creates conditional template files for MkDocs configuration and documentation structure
• Implements a unified GitHub Actions workflow for automatic docs deployment to GitHub Pages

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
copier.yml	Adds the new documentation_tool configuration option
template/mkdocs.yml.jinja	MkDocs configuration with Material theme setup
template/docs/index.md.jinja	Main documentation homepage for MkDocs
template/docs/reference/index.md.jinja	API reference page for MkDocs
template/.github/workflows/docs.yml.jinja	GitHub Actions workflow for docs deployment
template/pyproject.toml.jinja	Updates dependencies and tasks for both documentation tools
template/.gitignore.jinja	Adds ignore patterns for documentation build outputs
README.md	Documents the new documentation features

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[lsorber]

Hi @SimonJasansky, thanks for the PR, this will be a nice upgrade! Please see my comments below.

[lsorber]

I think it's shaping up nicely. Some more suggestions in this round.

[lsorber]

One more round, I expect the last one 🤞.

[lsorber]

Some more details.

[lsorber]

Looking forward to merging this!