Add doctest integration to test suite and fix docs build

[Copilot]

• Review existing documentation infrastructure
• Confirm documentation previews are already deployed for PRs (push_preview = true is already configured)
• Add test infrastructure that runs the full documentation build as part of Pkg.test()
  • Add the docs test dependencies needed by the manual @example blocks
  • Factor the shared docs builder into docs/build.jl
  • Run the docs build from test/integration/docs.jl
• Remove the unused DocumenterDiagrams dependency
• Keep QUBOTools in docs/Project.toml and document the local docs setup
• Verify package tests and the docs build

Summary of Changes

1. Documentation deployment with PRs: .github/workflows/docs.yml already deploys PR previews through push_preview = true, so no workflow change was needed there.

2. Examples in the docs now serve as tests: Pkg.test() runs the full Documenter build through test/integration/docs.jl and docs/build.jl, which exercises both docstring doctests and the manual @example blocks.

3. Shared docs build logic: docs/make.jl and the test suite now call the same build_docs helper, so local docs builds, CI docs builds, and docs tests use the same configuration.

4. Docs environment cleanup: DocumenterDiagrams was removed because it is unused. QUBOTools remains in docs/Project.toml so the docs environment explicitly declares the package it builds.

5. Local docs workflow: README.md now documents the local setup commands for the docs environment.

Fixes #26

[Copilot]

Pull request overview

This PR adds doctest execution to the Julia test suite to validate documentation examples, and adjusts the docs environment to resolve build issues by removing unused dependencies.

Changes:

• Integrates a new doctest runner (test/integration/docs.jl) into the integration test suite.
• Adds Documenter to test/Project.toml so doctests can run during Pkg.test.
• Removes DocumenterDiagrams and QUBOTools from the docs environment dependencies and updates docs/make.jl accordingly.

Reviewed changes

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

Show a summary per file

File	Description
test/integration/integration.jl	Adds doctest integration into the existing integration test entrypoint.
test/integration/docs.jl	Implements a test_doctest() helper that runs Documenter.doctest.
test/Project.toml	Adds Documenter to test dependencies and compat.
docs/make.jl	Removes DocumenterDiagrams usage to fix docs build issues.
docs/Project.toml	Removes unused docs dependencies (including QUBOTools and DocumenterDiagrams).

---

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

You can also share your feedback on Copilot code review. Take the survey.

[bernalde]

I ran the full package test suite (Pkg.test(), 608/608 passing) and a CI-like docs build (Pkg.develop(path=pwd()); include("docs/make.jl")). The package tests pass, but I still found two blocking regressions in the PR changes.

[bernalde]

Addressed the outstanding review comments in f96856c. The package tests now run the full docs build, and the local docs commands from the README were verified as well.

[Copilot]

Pull request overview

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

---

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

You can also share your feedback on Copilot code review. Take the survey.

[bernalde]

Addressed the latest Copilot review in e2b27de and merged origin/main to resolve the docs/make.jl conflict. The docs build path now logs the expected non-deployment case at info level, and the PR description has been updated to match the current branch state.

[Copilot]

Pull request overview

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

---

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

You can also share your feedback on Copilot code review. Take the survey.