feat(documentation): Add indexes to operator categories in operator documentation sources #2694
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.
This PR updates the logic in
ansys.dpf.core.documentation.generate_operators_doc.pyto create.mdindex pages for each operator category and for the mainoperator-specifications.mdfile, 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.