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

html docs: relative links are gone #1098

Closed
gordonwoodhull opened this issue Feb 12, 2016 · 4 comments
Closed

html docs: relative links are gone #1098

gordonwoodhull opened this issue Feb 12, 2016 · 4 comments
Labels
Milestone

Comments

@gordonwoodhull
Copy link
Contributor

JSDoc / docstrap is stripping out any links which point within the documentation. These were previously handled by relative hash-links (e.g. {@link #dc.coordinateGridMixin+brushOn}) which obviously won't work.

Probably JSDoc has a way to specify links semantically within a body of documentation.

Follow up to #1086

@gordonwoodhull gordonwoodhull added this to the v2.0 milestone Feb 12, 2016
@gordonwoodhull
Copy link
Contributor Author

As far as I can tell this is the only real blocker for "going live" with the HTML docs. (They're already online but not linked to anywhere.)

Internal links are pretty important; it looks like we have at least 64 of them:

$ grep 'link #' src/* | wc
      64     665    6281

Examples of missing links:

"brush" in http://dc-js.github.io/dc.js/docs/html/dc.lineChart.html#xyTipsOn__anchor
"itemWidth" in http://dc-js.github.io/dc.js/docs/html/dc.legend.html#autoItemWidth__anchor

@mtraynham
Copy link
Contributor

Figured it out, our links should take the format:

{@link dc.redrawAll dc.redrawAll}
{@link dc.baseMixin#redraw redraw}

Took me a while to find the class format. Will add a PR shortly.

@gordonwoodhull
Copy link
Contributor Author

Sweet!

@gordonwoodhull
Copy link
Contributor Author

fixed by #1109

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants