feat(doc): improve operator Markdown documentation generation #2635
Conversation
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
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #2635 +/- ##
==========================================
+ Coverage 84.14% 84.25% +0.11%
==========================================
Files 91 92 +1
Lines 10709 10819 +110
==========================================
+ Hits 9011 9116 +105
- Misses 1698 1703 +5 |
PProfizi
changed the title
PProfizi
added
enhancement
PProfizi
force-pushed
the
ci/automate_devreldocs_update
branch
from
439fedf to
de8b9be
Compare
PProfizi
commented
Sep 26, 2025
| / "dpf" | ||
| / "plugins" | ||
| / "dpf_composites" | ||
| / "composite_operators.dll", |
Contributor
Author
There was a problem hiding this comment.
We should make it compatible with Linux. Is this a priority though?
Contributor
Author
There was a problem hiding this comment.
Is there any reason to restrict it to Windows?
Contributor
Author
There was a problem hiding this comment.
-> Sound plugin exists only for Windows, but that is all
Contributor
Author
|
Check if it works for a remote server. |
PProfizi
commented
Sep 29, 2025
Contributor
|
Some tests with 'continue-on-error: true' have failed:
Created by continue-on-error-comment |
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.
Modifies
.ci/generate_operators_doc.pyby:--output_pathargument to select where to write the operator specs doc.toc.ymlrelative to the doc root.operator_docdependency group to listjinja2as optional requirement (requires a release for it to work)Also allow to generate the operator doc sources without cloning pydpf-core:
ansys.dpf.core.documentation.py)dpf_generate_operators_doc) upon installation of the librarydoc/source/operators_doc/operator-specifications/operator_doc_template.mdanddoc/source/operators_doc/operator-specifications/toc_template.j2