Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing links between packages in the generated documentation #566

Closed
sranka opened this issue Sep 13, 2022 · 0 comments · Fixed by #567
Closed

Missing links between packages in the generated documentation #566

sranka opened this issue Sep 13, 2022 · 0 comments · Fixed by #567
Assignees
Labels
bug Something isn't working
Milestone

Comments

@sranka
Copy link
Contributor

sranka commented Sep 13, 2022

Specifications

  • Client Version: 1.29
  • InfluxDB Version: any
  • Platform: any

Code sample to reproduce the problem

The generated documentation (generated by apidoc:generate) does not render links between packages. For example
https://influxdata.github.io/influxdb-client-js/influxdb-client-apis.authorizationsapi._constructor_.html now renders

| Parameter | Type | Description |
| influxDB | InfluxDB | an instance that knows how to communicate with InfluxDB server |

But it should render a link to InfluxDB type:

| Parameter | Type | Description |
| influxDB | InfluxDB | an instance that knows how to communicate with InfluxDB server |

Expected behavior

Links to influxdb-client-js identifiers are rendered as valid HTML achors.

Actual behavior

Links to influxdb-client-js identifiers are rendered only as a text.

@sranka sranka added the bug Something isn't working label Sep 13, 2022
@sranka sranka added this to the 1.30.0 milestone Sep 13, 2022
@sranka sranka self-assigned this Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
1 participant