Skip to content

remove meshing#670

Merged
joamatab merged 1 commit intomainfrom
remove_meshing
Feb 3, 2026
Merged

remove meshing#670
joamatab merged 1 commit intomainfrom
remove_meshing

Conversation

@joamatab
Copy link
Contributor

@joamatab joamatab commented Feb 3, 2026

Summary by Sourcery

Documentation:

  • Remove the meshing plugin page and its associated meshing notebooks from the documentation navigation.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Feb 3, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Removes the meshing plugin and its associated tutorial notebooks from the documentation table of contents so they no longer appear in the built docs.

Flow diagram for docs build using updated table of contents without meshing

flowchart TD
  A_docs_source[Docs source files] --> B_toc_yaml[Docs _toc.yml]
  B_toc_yaml --> C_docs_builder[Docs builder]
  C_docs_builder --> D_nav_structure[Computed navigation structure]
  D_nav_structure --> E_built_docs[Built documentation]

  subgraph Removed_entries
    R1_plugins_mesh[plugins_mesh section]
    R2_meshing_01[notebooks/meshing_01_intro]
    R3_meshing_02[notebooks/meshing_02_2D_xy_mesh]
    R4_meshing_03[notebooks/meshing_03_2D_uz_mesh]
    R5_meshing_04[notebooks/meshing_04_refinement]
    R6_meshing_05[notebooks/meshing_05_3D]
  end

  B_toc_yaml -. no longer referenced .- Removed_entries
  Removed_entries -. excluded from navigation .- D_nav_structure
  style Removed_entries fill:#fdd,stroke:#f99
Loading

File-Level Changes

Change Details Files
Remove meshing documentation section from the docs table of contents.
  • Delete the 'plugins_mesh' entry from the documentation navigation structure.
  • Remove references to the meshing tutorial notebooks from the TOC section list.
  • Leave remaining plugin and notebook entries (e.g., optimiser and process) unchanged.
docs/_toc.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@joamatab joamatab added the documentation Improvements or additions to documentation label Feb 3, 2026
@joamatab joamatab merged commit 4ac2c45 into main Feb 3, 2026
15 of 18 checks passed
@joamatab joamatab deleted the remove_meshing branch February 3, 2026 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant