Typedoc: How to not generate source file links?

Created on 13 May 2017  路  4Comments  路  Source: TypeStrong/typedoc

Is there a setting to not have typedoc generate source file links (ie. The "Defined in URL_to_source _and_line_number")?

I have no need for this feature and it results in very noisy commits whenever I run typedoc and put the output into /docs on master branch because blob URLs for referenced sources changes every time

Most helpful comment

You can specify --gitRevision to tell TypeDoc what to use instead of the current ish.

All 4 comments

You can do this by modifying the theme if you'd like. That's the route we took.

In the theme project, you'll want to update src/default/partials/member.declaration.hbs and src/default/partials/member.signature.body.hbs. See the following commit: Don't include source information.

Closing in favor of #808 as it seems to have more visibility.

A middleground option that allows you to keep "defined in", but generates a less noisy output is to output just the filename and line in src/default/partials/member.declaration.hbs

<li>Defined in {{fileName}}:{{line}}</li>

It would be even nicer if there was a feature that generated the link from the master branch instead of from the unique commit. That way it would only generate changes if the file structure changed and unless you were keeping multiple versions of documentation it would just work.

You can specify --gitRevision to tell TypeDoc what to use instead of the current ish.

Was this page helpful?
0 / 5 - 0 ratings