pdoc3 / pdoc

:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
https://pdoc3.github.io/pdoc/
GNU Affero General Public License v3.0
1.13k stars 145 forks source link

Links not generated in Markdown tables #447

Closed AnthonyZJiang closed 3 months ago

AnthonyZJiang commented 3 months ago
Screenshot 2024-06-25 at 11 34 00

As seen in the above image, the links for the class types are not generated. The related HTML code:

<table>
<thead>
<tr>
<th>Variable</th>
<th>Class type</th>
<th>Port</th>
</tr>
</thead>
<tbody>
<tr>
<td><dt><code>powers</code></dt></td>
<td><code>isotope.port.PowerOutput</code></td>
<td>Power output ports, i.e. Output X.</td>
</tr>
<tr>
<td><dt><code>motors</code></dt></td>
<td><code>isotope.port.Motor</code></td>
<td>Stepper motor ports, i.e. MOT X.</td>
</tr>
<tr>
<td><dt><code>adcs</code></dt></td>
<td><code>isotope.port.ADCInput</code></td>
<td>Analogue-digital-converter ports, i.e. ADC X.</td>
</tr>
<tr>
<td><dt><code>pwms</code></dt></td>
<td><code>isotope.port.PWMOutput</code></td>
<td>PWM output ports, i.e. PWM X.</td>
</tr>
<tr>
<td><dt><code>temps</code></dt></td>
<td><code>isotope.port.TempInput</code></td>
<td>Temperature sensor ports, i.e. TEMP X.</td>
</tr>
</tbody>
</table>

related docstring:

    | Variable   | Class type                 | Port                                            |
    |------------|----------------------------|-------------------------------------------------|
    | `powers`   | `isotope.port.PowerOutput` | Power output ports, i.e. Output X.              |
    | `motors`   | `isotope.port.Motor`       | Stepper motor ports, i.e. MOT X.                |
    | `adcs`     | `isotope.port.ADCInput`    | Analogue-digital-converter ports, i.e. ADC X.   |
    | `pwms`     | `isotope.port.PWMOutput`   | PWM output ports, i.e. PWM X.                   |
    | `temps`    | `isotope.port.TempInput`   | Temperature sensor ports, i.e. TEMP X.          |

Steps to Reproduce

  1. git clone https://github.com/ICE9-Robotics/isotope_sdk
  2. cd isotope_sdk
  3. pdoc --html --output-dir docs/ --force python_lib/isotope/isotope

Additional info

AnthonyZJiang commented 3 months ago

the docstring was incorrect, that's why.