GEOPY-2745: Refresh screenshots of UIJsons in docs#66
Open
benk-mira wants to merge 4 commits into
Open
Conversation
github-actions
Bot
changed the title
There was a problem hiding this comment.
Pull request overview
Updates Sphinx/reStructuredText documentation pages related to block model workflows, adjusting how an (octree grid) figure is represented so the docs build/render cleanly.
Changes:
- Replaced line-block “commented” figure markup with reST comment-style markup in
block_model.rst. - Replaced line-block “commented” figure markup with reST comment-style markup in
block_model_to_octree.rst.
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/source/block_model.rst | Adjusts the (currently commented) octree_grid.png figure markup to avoid rendering it as literal text. |
| docs/source/block_model_to_octree.rst | Same figure-markup adjustment for the Block Model → Octree documentation page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
domfournier
reviewed
May 27, 2026
Contributor
domfournier
left a comment
domfournier
left a comment
There was a problem hiding this comment.
Great, thanks for the first round.
Would you mind keeping the common layout for the docs of Block model to octree and Block model creation? Should be something along the lines of:
Intro (with nice figure after first paragraph)
Interface (show UI and bullet the inputs)
Methodology
Example
|
|
||
| # .. figure:: /images/octree_grid.png | ||
| # :width: 800 | ||
| In its most simple form, the application will create an octree with the core region matching the cells of the block model with a small padding region where the cells are allowed to expand. |
Contributor
There was a problem hiding this comment.
Suggested change
| In its most simple form, the application will create an octree with the core region matching the cells of the block model with a small padding region where the cells are allowed to expand. | |
| In its simplest form, the application will create an octree with the core region matching the cells of the block model. Cells are allowed to expand to the closest octree level within the volume of padding cells. |
Comment on lines
+6
to
9
| .. figure:: /images/block_model_to_octree_uijson.png | ||
| :width: 500 | ||
|
|
||
| The ``Block model to Octree`` module has been developed as a user-interface for the conversion between regular (Tensor) BlockModel objects to Octree, using the `discretize <https://discretize.simpeg.xyz/en/main/>`_ package. |
Contributor
There was a problem hiding this comment.
Suggested change
| .. figure:: /images/block_model_to_octree_uijson.png | |
| :width: 500 | |
| The ``Block model to Octree`` module has been developed as a user-interface for the conversion between regular (Tensor) BlockModel objects to Octree, using the `discretize <https://discretize.simpeg.xyz/en/main/>`_ package. | |
| The ``Block model to Octree`` module has been developed as a user-interface for the conversion between regular (Tensor) BlockModel objects to Octree, using the `discretize <https://discretize.simpeg.xyz/en/main/>`_ package. | |
| .. figure:: /images/block_model_to_octree_uijson.png | |
| :width: 500 | |
Comment on lines
+18
to
+19
| .. figure:: /images/block_model_to_octree_advanced.png | ||
| :width: 800 |
Contributor
There was a problem hiding this comment.
Sorry to be picky, but can we use a ReferencedData instead? The refinement on the boundaries will be much clearer.
Co-authored-by: domfournier <dominiquef@mirageoscience.com>
Co-authored-by: domfournier <dominiquef@mirageoscience.com>
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.
GEOPY-2745 - Refresh screenshots of UIJsons in docs