Docs/wiki conversion#914
Merged
Merged
Conversation
"merge to fetch changes made in dev"
Merging of changes made to the documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation polish for the matRad Sphinx docs: refreshes the Quick Start pages with new screenshots and rewritten prose, adds a favicon set wired in via a custom Sphinx template, and bumps the docs copyright year to 2026.
Changes:
- Replace legacy GUI/script Quick Start screenshots with new
QuickStart_*images and reword Quick Start text (incl. renaming "Set optimization parameters" → "Set objectives and constraints", adding profile/3D viewer sections). - Add favicon assets (
favicon_hat/,favicon_mR/) plus a_templates/layout.htmlthat injects favicon/apple‑touch/manifest links, wired viatemplates_path,favicon_path, andhtml_contextinconf.py. - Update
copyrightindocs/conf.pyto 2026.
Reviewed changes
Copilot reviewed 7 out of 48 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/conf.py | Bumps copyright to 2026; adds templates_path, favicon_path, and html_context for favicon wiring. |
| docs/_templates/layout.html | New Sphinx template injecting favicon/apple‑touch/manifest links into extrahead. |
| docs/_static/favicon_hat/site.webmanifest | New PWA manifest for the "hat" favicon set (uses root‑absolute icon paths). |
| docs/_static/favicon_mR/site.webmanifest | New PWA manifest for the "mR" favicon set (uses root‑absolute icon paths). |
| docs/quickstart/index.rst | Rewrites intro and the three "Option" blurbs for the Quick Start landing page. |
| docs/quickstart/guiintro.rst | Updates step headings/screenshots, renames optimization section to "Objectives and constraints", adds profile and 3D viewer subsections. |
| docs/quickstart/matradscript.rst | Replaces screenshots with new QuickStart_Script_* images and tweaks tip/instruction wording. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| .. image:: /images/QuickStart_GUI_GUI_after_Optimization.png | ||
| :width: 650px | ||
|
|
||
| You can choose between an intensity plot (for the coronal, sagital and axial plane) and a profile plot (either depth or lateral, see images below), for which you can choose your slice to be displayed, respectively: |
| :width: 50% | ||
|
|
||
|
|
||
| Furthermore, you can have a look at your slice within a 3D model of your patient by clicking *Open 3D Viewer*: |
| @@ -0,0 +1 @@ | |||
| {"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} No newline at end of file | |||
| @@ -0,0 +1 @@ | |||
| {"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} No newline at end of file | |||
|
|
||
| To calculate a DVH of all VOIs and to see the quality indicators (which contain the mean/max/min dose for each VOI) you can use the **Show DVH/QI** button in the *Visualization* section. | ||
|
|
||
| .. image:: /images/DVHVisScreenshot.png |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #914 +/- ##
=======================================
Coverage 54.86% 54.86%
=======================================
Files 320 320
Lines 20527 20527
=======================================
Hits 11262 11262
Misses 9265 9265 ☔ View full report in Codecov by Sentry. |
wahln
approved these changes
May 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Smaller updates in documentation (especially Quickstart), created favicon for different OS, changed copyright to 2026