MyST-Parser icon indicating copy to clipboard operation
MyST-Parser copied to clipboard

Cross reference link to Child class is disappeared

Open atifkarim opened this issue 4 years ago • 0 comments

I am using breathe to parse Doxygen XML output and dump them in a markdown file using myST. An issue is facing that, Parent class formerly shows a cross-reference link to Child class by using a word Subclassed by while whole project based on only reST.

Eg:

Subclassed by B, C

It was handy to navigate from the Parent class to it's Child by clicking on the child class name. But since I am using myST that cross-reference link is disabled (The information is present but cannot click)

sample.cpp

namespace X{
class A{};

class B : public A {};

class C : public A {};

Approach to use breathe directive to parse Doxygen XML output

class.md

```{eval-rst}
.. doxygenclass:: X::A
```

```{eval-rst}
.. doxygenclass:: X::B
```

```{eval-rst}
.. doxygenclass:: X::C
```

Approach to include all markdown (here is showed only 1) in a toctree, in another markdown file

include_all.md

(section_all_md)=
# List of resources

```{toctree}
:maxdepth: 2

class
```

Here, class.md and include_all.md are in same directory (let assume directory name md_files)

In main doc I have included as like as follows

index.md

# Contents

```{toctree}
:maxdepth: 2

md_files/include_all
```
  • How that cross-reference link can be achieved?
  • If not possible, is there any way to permanently remove those information lines?

atifkarim avatar Dec 16 '21 09:12 atifkarim