updating documentation

[keighrim]

addressing #348 and various minor documentation issues

[Copilot]

Pull request overview

Updates project and CLI documentation to address issue #348 and improve Sphinx-generated docs, including summarizer and CLI module autodoc coverage.

Changes:

• Refactors/standardizes docstrings across summarizer modules and CLI entry points.
• Improves Sphinx docs structure (new summarizer page, new autodoc pages, updated index/modules, updated “what’s new” generation).
• Adjusts CLI help text generation to be more readable in terminal help output and in published docs.

Reviewed changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
mmif/utils/summarizer/utils.py	Cleans up module docstring formatting.
mmif/utils/summarizer/summary.py	Replaces a very large module header with shorter module docs and refines class docstrings.
mmif/utils/summarizer/graph.py	Improves docstrings and type hints for Graph utilities and TokenIndex docs.
mmif/utils/summarizer/init.py	Adds a package-level docstring describing the summarizer behavior and usage.
mmif/utils/cli/summarize.py	Adds docstrings and typing for the summarize CLI module.
mmif/utils/cli/describe.py	Simplifies CLI descriptions and adds an RST-oriented help generator.
mmif/init.py	Adds an argparse builder intended for documentation builds.
documentation/target-versions.rst	Refines intro text for target-version docs.
documentation/summarizer.rst	Adds a dedicated summarizer documentation page.
documentation/plugins.rst	Minor wording/formatting cleanups in plugin docs.
documentation/modules.rst	Adds autodoc entry for mmif.utils.cli.
documentation/introduction.rst	Updates installation/prerequisite text and improves examples.
documentation/index.rst	Reworks the Sphinx landing page structure and toctree.
documentation/conf.py	Refactors CLI/whatsnew generation during Sphinx builds; adds minor documentation-related utilities.
documentation/cli.rst	Updates CLI page wording and usage snippet.
documentation/autodoc/mmif.utils.summarizer.rst	Adds autodoc page for the summarizer package/modules.
documentation/autodoc/mmif.utils.cli.rst	Adds autodoc page for CLI package/modules.
documentation-notes.md	Adds internal notes about documentation work and open issues.
README.md	Improves README wording and links.
.gitignore	Updates ignored generated docs artifact name (whatsnew.md).

---

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

[Copilot]

The example uses file mode 'b' (binary) which is not a valid mode by itself in Python's open(). Use a concrete binary mode like 'rb' (read binary).

Suggested change

	with open(video.location_path(), 'b') as in_video:
	with open(video.location_path(), 'rb') as in_video:

[codecov]

Codecov Report

❌ Patch coverage is 93.75000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 66.58%. Comparing base (660d778) to head (5d36df6).
⚠️ Report is 23 commits behind head on develop.

Files with missing lines	Patch %	Lines
mmif/__init__.py	83.33%	1 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@## develop #355 +/- ##
===========================================
+ Coverage 65.62% 66.58% +0.96% 
===========================================
Files 22 22 Lines 2845 2846 +1 ===========================================
+ Hits 1867 1895 +28 + Misses 978 951 -27 

Flag	Coverage Δ
unittests	66.58% <93.75%> (+0.96%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[keighrim]

@marcverhagen I did a force-push to your branch (really sorry about that, but the commit history was very messy (between cross-merges and PRs) and I couldn't read the code changes... Please pull fetch from your side and see if anything went bad during my cherry-picks and force push.

[keighrim]

Unless you want to write a full parser/converter between md callout syntax and rst admonition syntax, I think we should just live with this. (also callouts in release notes aren't that frequent anyway)

[keighrim]

I closed ("resolve" button) all the comments that are addressed in #356 .

[keighrim]

Marc and I discussed changes in this PR (and #356 ) in a in-person meeting and decided to merge.