format_examples in the docs #601
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates reference labels and titles in the documentation examples to use consistent naming based on file names, and comments out gallery generation and cheatsheet configurations in the Sphinx documentation build.
- Updates reference labels in postprocessing examples to match their file names
- Disables Sphinx gallery generation and related build settings
- Adds a new cheatsheet extension configuration file
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/00-postprocessing/post_processing_plotter_context_manager.py | Updated reference label and title to match file name |
| examples/00-postprocessing/post_processing_plotter.py | Updated reference label and title for consistency |
| examples/00-postprocessing/post_processing_legacy.py | Updated reference label and title to reflect legacy status |
| examples/00-postprocessing/post_processing_callbacks_and_animation.py | Updated reference label to match file name |
| examples/00-postprocessing/post-processing_context_manager.py | Updated reference label and simplified title |
| doc/source/conf.py | Commented out gallery generation, pyvista settings, and cheatsheet configuration |
| doc/source/cheatsheet/_extensions/ansys/cheat_sheet/_extension.yml | Added new cheatsheet extension configuration |
| doc/api_rstgen.py | Modified API index title generation to use "API reference" for visualization folder |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
doc/source/conf.py
Outdated
| "ignore_pattern": r"script_manifold\.py|post_processing_exhaust_manifold\.py|" | ||
| r"updated_script_manifold_example\.py|enhanced_postprocessing\.py", | ||
| "ignore_pattern": r"post_processing_callbacks_and_animation\.py|post_processing_legacy\.py|" | ||
| r"post_processing_plotter\.py|*_context_manager\.py", |
There was a problem hiding this comment.
The wildcard pattern '_context_manager.py' will not match files correctly in a regex context. The asterisk '' has special meaning in regex and should be '.' for proper matching. This should be '._context_manager.py'.
| r"post_processing_plotter\.py|*_context_manager\.py", | |
| r"post_processing_plotter\.py|.*_context_manager\.py", |
| @@ -0,0 +1,55 @@ | |||
| # Copyright (C) 2024 ANSYS, Inc. and/or its affiliates. | |||
There was a problem hiding this comment.
Why is this file required?
doc/source/conf.py
Outdated
| pyvista.FIGURE_PATH = os.path.join(os.path.abspath("./images/"), "auto-generated/") | ||
| if not os.path.exists(pyvista.FIGURE_PATH): | ||
| os.makedirs(pyvista.FIGURE_PATH) | ||
| # pyvista.FIGURE_PATH = os.path.join(os.path.abspath("./images/"), "auto-generated/") |
There was a problem hiding this comment.
Please avoid committing these changes. Keep them locally only.
There was a problem hiding this comment.
Sorry, I'll keep that in mind.
| Enhanced Postprocessing | ||
| ----------------------- | ||
| Post-processing context manager |
There was a problem hiding this comment.
Context-managed post-processing workflow
There was a problem hiding this comment.
@mayankansys, update the description as required as well for all examples.
| """.. _ref_post_processing_plotter: | ||
| Enhanced Postprocessing with PyVista and Matplotlib | ||
| Post-processing with PyVista and Matplotlib plotter |
There was a problem hiding this comment.
Advanced post-processing using PyVista and Matplotlib plotter apis
| Enhanced Postprocessing | ||
| ----------------------- | ||
| Post-processing with access to plotter and context manager |
There was a problem hiding this comment.
Context managed advanced Post-Processing using PyVista and Matplotlib Plotter APIs
mayankansys
force-pushed
the
docs/format_examples
branch
from
87fbb95 to
dea2208
Compare
mayankansys
force-pushed
the
docs/format_examples
branch
from
29f9c8f to
a62131a
Compare
for more information, see https://pre-commit.ci
…ent-visualization into docs/format_examples
No description provided.