Skip to content

Conversation

@PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Oct 21, 2025

This PR updates the logic in ansys.dpf.core.documentation.generate_operators_doc.py to create .md index pages for each operator category and for the main operator-specifications.md file, enabling traversing the operator doc when generating it locally using DocFX.
It was previously impossible to access the operators or to list them by category as there is no navigation panel specific to operators when the doc is generated locally.

EDIT: since then, the local doc has been fixed to include the left navigation panel. However, this is still useful as this gives a landing page for each category, which makes the top navigation bar usable on the local doc.

@PProfizi PProfizi requested a review from AnsMelanie October 21, 2025 18:53
@PProfizi PProfizi self-assigned this Oct 21, 2025
@PProfizi PProfizi added the enhancement New feature or request label Oct 21, 2025
@codecov
Copy link

codecov bot commented Oct 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.33%. Comparing base (1362534) to head (cf1c8fc).
⚠️ Report is 2 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2694      +/-   ##
==========================================
+ Coverage   84.28%   84.33%   +0.04%     
==========================================
  Files          92       92              
  Lines       10858    10890      +32     
==========================================
+ Hits         9152     9184      +32     
  Misses       1706     1706              

@github-actions
Copy link
Contributor

Some tests with 'continue-on-error: true' have failed:

  • PyDPF-Post API tests on ubuntu-latest

Created by continue-on-error-comment

@PProfizi PProfizi enabled auto-merge (squash) October 23, 2025 15:13
@PProfizi PProfizi merged commit 3323383 into main Oct 23, 2025
86 of 87 checks passed
@PProfizi PProfizi deleted the feat/improve_dpf_documentation_local_generation branch October 23, 2025 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants