ansys / ansys/pyconverter-xml2py

Use Sphinx footnotes for ``Footnote``

Open
#418 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
6
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### 📝 Description of the feature

Footnotes are not properly handled as the ``Footnote`` class is not modified from the ``Element`` class. Implementing Sphinx footnotes could be a good approach.
``XRef`` could also make use of Sphinx footnotes?

[Sphinx documentation](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes) for reference

This was first raised by https://github.com/ansys/pymapdl/pull/3892#discussion_r2075144834

### 💡 Steps for implementing the feature

Add ``to_rst`` method in ``Footnote`` class.
Modify ``to_rst`` method in ``XRef`` class.

### 🔗 Useful links and references

``Footnote`` use cases:
- ``cnvtol``
- ``esol``: ``SOL - General Result Item and Component Labels`` - see https://github.com/ansys/pymapdl/pull/3892#discussion_r2075122923
- ``etable``
- ...

``XRef`` use cases:
- ``nsol`` in **NSOL - Valid Item and Component Labels** table
- ``rforce`` in **RFORCE - Valid Item and Component Labels**
- ...

Contributor guide

Open the contributing guide

Research direction

Locate the Footnote and XRef classes and their existing to_rst methods, then review the linked Sphinx footnotes documentation and the cnvtol, esol, etable, nsol, and rforce use cases. Done means Footnote output follows Sphinx footnote syntax and XRef output handles the referenced cases correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.